Version 1.0.0

- added info section with contact and thanks
- fixed minor clarifications and spellings errors on help texts

.pkgmeta

@@ -4,6 +4,8 @@ enable-nolib-creation: no
 
 externals:
   libs/LibStub: https://repos.wowace.com/wow/libstub/tags/1.0
+  libs/LibDataBroker: https://github.com/tekkub/libdatabroker-1-1
+  libs/LibDBIcon: https://repos.curseforge.com/wow/libdbicon-1-0/trunk/LibDBIcon-1.0
   libs/CallbackHandler-1.0: https://repos.wowace.com/wow/callbackhandler/trunk/CallbackHandler-1.0
   libs/AceAddon-3.0: https://repos.wowace.com/wow/ace3/trunk/AceAddon-3.0
   libs/AceConfig-3.0: https://repos.wowace.com/wow/ace3/trunk/AceConfig-3.0

CHANGELOG.md

@@ -3,17 +3,61 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Upcoming] Version 0.8.0-beta - 2020-06-08
+## Version 1.0.0 - 2020-09-01 [First Release]
+### Added
+- info section with contact and thanks
+### Fixed
+- minor clarifications and spellings errors on help texts
+
+## Version 0.9.1-rc - 2020-08-01 [Release Candidate]
+### Fixed
+- emote detection mixed in other channels
+- minimap button and dialog no longer resets active state after profile change
+- default entries are no longer shown after example import
+- better handling of capture groups and character sets
+
+## Version 0.9.0-rc - 2020-07-25 [Release Candidate]
+### Added
+- enable/disable from slash command
+- matching conditions (never, always, start, end, start or end)
+- support capturing groups
+- import examples
+- testing capabilities
+- compatibility with WoW Retail
+### Changed
+- adapted help texts
+- spelling errors
+
+## Version 0.8.1-beta - 2020-06-16
+### Added
+- stop replacements per mapping
+- more ooc recognition patterns
+### Fixed
+- keep cases of over-long replacements
+
+## Version 0.8.0-beta - 2020-06-14 [Feature Complete]
 ### Added
 - handle replacement via slash command
-- emote detection
+- emote and ooc detection
+- de-/activate single mappings
+- move buttons are disabled when already at top/bottom or replacements were deactivated
+- minimap button is darkened when addon is disabled
+- help tab with examples
+### Changed
+- right-click on minimap button quickly de-/activates replacements
+### Fixed
+- mapping to raid warning, instance and battleground chats
+- localized raid target markers
+- capital % substitutions
+- incorrect consolidation
+- Umlaut and accent replacements
 
 ## Version 0.7.2-beta - 2020-06-08
 ### Added
 - minimap button
 ### Changed
 - graphical move arrows
-###Fixed
+### Fixed
 - crash on matches with 0-width
 
 ## Version 0.7.1-beta - 2020-06-07

Grichelde.lua

@@ -1,6 +1,7 @@
 --[[---------------------------------------------------------------------------
 
   Grichelde - Text Replacer
+
   Copyright 2020 Teilzeit-Jedi <tj@teilzeit-jedi.de>
 
   This addon is distributed in the hope that it will be useful,
@@ -19,39 +20,46 @@ local _G = _G
 
 -- initialize addon
 local Grichelde = LibStub("AceAddon-3.0"):NewAddon(AddonTable, AddonName, "AceConsole-3.0", "AceEvent-3.0", "AceHook-3.0")
-Grichelde.L = LibStub("AceLocale-3.0"):GetLocale("Grichelde", true)
 Grichelde.version = GetAddOnMetadata(AddonName, "Version")
 Grichelde.build = GetAddOnMetadata(AddonName, "X-Build") or "Experimental"
 Grichelde.classic = _G.WOW_PROJECT_ID == _G.WOW_PROJECT_CLASSIC
 Grichelde.logLevel = 0      -- cannot reference Grichelde.LOG_LEVELs here as they are loaded afterwards
 
 -- publish to global env
-_G.Grichelde = Grichelde
+_G[AddonName] = Grichelde
 
 -- Ace3 callbacks
 function Grichelde:OnInitialize()
+    self.L = LibStub("AceLocale-3.0"):GetLocale(self.name, true)
+
     -- Build Interface Options window
     self.db = self:LoadDatabase()
     self:UpgradeDatabase()
-
-    self.options, self.dialog = self:SetupOptions()
-    self:RefreshOptions("OnProfileChanged")
-
-    self.ldb, self.icon = self:MinimapButton()
-
-    self:SetupSlashCommands()
 end
 
 function Grichelde:OnEnable()
     -- Hook in before message is sent to replace all character occurrences where replacements have been defined in the options
     self:RawHook("SendChatMessage", true)
 
+    self.options, self.dialog = self:SetupOptions()
+    self.ldb, self.icon = self:MinimapButton()
+
+    self:RefreshProfiles("OnEnable")
+    self:SetupSlashCommands()
+
     -- tell the world we are listening
-    self:Print(self.L.AddonLoaded, self.COLOR_CODES.PREFIX .. self.L.AddonName .. " " .. self.L.VersionAbbr .. self.version .. self.COLOR_CODES.CLOSE)
+    if (self.db.profile.enabled == true) then
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        self.F.print(self:Format(self.L.AddonLoaded, self.COLOR_CODES.PREFIX .. namePlusVersion .. self.COLOR_CODES.CLOSE))
+    end
 end
 
 function Grichelde:OnDisable()
     self:Unhook("SendChatMessage")
+    self:CloseOptions()
+    self:HideMinimapButton()
+    self:UnregisterChatCommand("grichelde")
+    self:UnregisterChatCommand("gri")
 end
 
 --- Register  slash commands 'gri' and 'grichelde'
@@ -60,19 +68,25 @@ function Grichelde:SetupSlashCommands()
     self:RegisterChatCommand("gri", "HandleSlashCommand")
 end
 
-function Grichelde:HandleSlashCommand(input)
+function Grichelde:HandleSlashCommand(input, ...)
     -- Show the GUI if no input is supplied, otherwise handle the chat input.
-    if self.functions.nilOrEmpty(input) then
+    if (self.F.nilOrEmpty(input)) then
-        self:OpenOptions()
+        self:ToggleOptions()
     else
         -- handle slash ourselves
         self:DebugPrint("Handle slash command: " .. input)
         if input == "mappings" then
             self:ToogleMappings()
         elseif input == "options" then
-            self:PrintOptions()
+            self:ToggleOptions()
         elseif input == "profile" then
             self:PrintProfile()
+        elseif input == "on" or input == "enable" then
+             self:Activate()
+        elseif input == "off" or input == "disable" then
+             self:Deactivate()
+        else
+            self:SendChatMessageOverride(input, ...)
         end
     end
 end

Grichelde.toc

@@ -1,9 +1,9 @@
-## Interface: 11304
+## Interface: 11305
 
 ## Title: Grichelde
-## Notes: Replaces characters from the chat box
+## Notes: Replaces characters of your chat input line before sending.
-## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile
+## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile vor dem Versand.
-## Version: 0.7.2-beta
+## Version: 1.0.0
 ## Author: Teilzeit-Jedi
 ## eMail: tj@teilzeit-jedi.de
 
@@ -12,18 +12,23 @@
 ## X-License: GPLv3
 ## X-Category: Chat/Communication
 ## X-Credits: Teilzeit-Jedi
-## X-Embeds: Ace3
+## X-Embeds: LibStub, CallbackHandler, Ace3, LibDataBroker, LibDBIcon
 
-## OptionalDeps: Ace3, LibDataBroker, LibIcon
+## OptionalDeps: LibStub, CallbackHandler, Ace3, LibDataBroker, LibDBIcon
 ## SavedVariables: GricheldeDB
 
 libs.xml
-localisation.xml
 
 Grichelde.lua
 GricheldeConstants.lua
+
+localisation.xml
+
 GricheldeUtils.lua
 GricheldeDatabase.lua
 GricheldeUpgrade.lua
 GricheldeOptions.lua
+GricheldeMinimap.lua
 GricheldeChat.lua
+
+GricheldeTest.lua

GricheldeConstants.lua

@@ -1,41 +1,166 @@
 -- read namespace from global env
 local _G = _G
-local Grichelde = _G.Grichelde
+local Grichelde = _G.Grichelde or {}
 
 -- constants and upvalues
-Grichelde.LOG_LEVEL = {}
+Grichelde.LOG_LEVEL = { DEBUG = 1, TRACE = 2 }
-Grichelde.LOG_LEVEL.DEBUG = 1
-Grichelde.LOG_LEVEL.TRACE = 2
 
 Grichelde.MAPPING_OFFSET = 10
+Grichelde.MINIMAP_ENABLED = 1.0
+Grichelde.MINIMAP_DARKENDED = 0.5
 
-Grichelde.ICONS = {}
+Grichelde.ICONS = {
-Grichelde.ICONS.MOVE_UP = "Interface\\MainMenuBar\\UI-MainMenu-ScrollUpButton-Up"
+    MOVE_UP = "Interface\\MainMenuBar\\UI-MainMenu-ScrollUpButton-Up",
-Grichelde.ICONS.MOVE_DOWN = "Interface\\MainMenuBar\\UI-MainMenu-ScrollDownButton-Up"
+    MOVE_UP_DISABLED = "Interface\\MainMenuBar\\UI-MainMenu-ScrollUpButton-Disabled",
+    MOVE_DOWN = "Interface\\MainMenuBar\\UI-MainMenu-ScrollDownButton-Up",
+    MOVE_DOWN_DISABLED = "Interface\\MainMenuBar\\UI-MainMenu-ScrollDownButton-Disabled",
+    DELETE = "Interface\\Buttons\\UI-Panel-MinimizeButton-Up",
+    DELETE_DISABLED = "Interface\\Buttons\\UI-Panel-MinimizeButton-Disabled",
+}
 
 -- colors:
-Grichelde.COLORS = {}
+Grichelde.COLORS = {
-Grichelde.COLORS.NORMAL    = _G.NORMAL_FONT_COLOR
+    NORMAL    = _G.NORMAL_FONT_COLOR,
-Grichelde.COLORS.HIGHLIGHT = _G.HIGHLIGHT_FONT_COLOR
+    HIGHLIGHT = _G.HIGHLIGHT_FONT_COLOR,
-Grichelde.COLORS.RED       = _G.RED_FONT_COLOR
+    RED       = _G.RED_FONT_COLOR,
-Grichelde.COLORS.GREEN     = _G.GREEN_FONT_COLOR
+    GREEN     = _G.GREEN_FONT_COLOR,
+}
 
-Grichelde.COLOR_CODES = {}
+Grichelde.COLOR_CODES = {
-Grichelde.COLOR_CODES.PREFIX      = "|c00FFAA00"
+    PREFIX      = "|c00FFAA00",
--- https://github.com/stoneharry/Misc-WoW-Stuff/blob/master/EoC%20Interface/FrameXML/Constants.lua
+    -- https://github.com/stoneharry/Misc-WoW-Stuff/blob/master/EoC%20Interface/FrameXML/Constants.lua
-Grichelde.COLOR_CODES.NORMAL      = _G.NORMAL_FONT_COLOR_CODE      or "|cffffd200"
+    NORMAL      = _G.NORMAL_FONT_COLOR_CODE      or "|cffffd200",
-Grichelde.COLOR_CODES.HIGHLIGHT	  = _G.HIGHLIGHT_FONT_COLOR_CODE   or "|cffffffff"
+    HIGHLIGHT   = _G.HIGHLIGHT_FONT_COLOR_CODE   or "|cffffffff",
-Grichelde.COLOR_CODES.RED         = _G.RED_FONT_COLOR_CODE         or "|cffff2020"
+    RED         = _G.RED_FONT_COLOR_CODE         or "|cffff2020",
-Grichelde.COLOR_CODES.GREEN       = _G.GREEN_FONT_COLOR_CODE       or "|cff20ff20"
+    GREEN       = _G.GREEN_FONT_COLOR_CODE       or "|cff20ff20",
-Grichelde.COLOR_CODES.LIGHTGRAY   = "|cffC0C0C0"
+    LIGHTGRAY   = "|cffC0C0C0",
-Grichelde.COLOR_CODES.GRAY        = _G.GRAY_FONT_COLOR_CODE        or "|cff808080"
+    GRAY        = _G.GRAY_FONT_COLOR_CODE        or "|cff808080",
-Grichelde.COLOR_CODES.DARKGRAY    = "|cff404040"
+    DARKGRAY    = "|cff404040",
-Grichelde.COLOR_CODES.YELLOW      = _G.YELLOW_FONT_COLOR_CODE      or "|cffffff00"
+    YELLOW      = _G.YELLOW_FONT_COLOR_CODE      or "|cffffff00",
-Grichelde.COLOR_CODES.LIGHTYELLOW = _G.LIGHTYELLOW_FONT_COLOR_CODE or "|cffffff9a"
+    LIGHTYELLOW = _G.LIGHTYELLOW_FONT_COLOR_CODE or "|cffffff9a",
-Grichelde.COLOR_CODES.ORANGE      = _G.ORANGE_FONT_COLOR_CODE      or "|cffff7f3f"
+    ORANGE      = _G.ORANGE_FONT_COLOR_CODE      or "|cffff7f3f",
-Grichelde.COLOR_CODES.CLOSE       = _G.FONT_COLOR_CODE_CLOSE       or "|r"
+    BLUE        = "|cff0000ff",
+    HYPERLINK   = "|cff4040ff",
+    CLOSE       = _G.FONT_COLOR_CODE_CLOSE       or "|r",
+}
 
-Grichelde.slashCommands = { "/s", "/say", "/e", "/em", "/me", "/emote", "/y", "/yell", "/sh", "/shout", "/p", "/party", "/pl", "/partyleader", "/g", "/gc", "/guild", "/o", "/osay", "/officer", "/raid", "/rsay", "/rl", "/raidleader", "/rw", "/raidwarning", "/i", "/instance", "/bg", "/battleground", "/w", "/whisper", "/t", "/tell", "/send", "/r", "/reply" }
+Grichelde.SLASH_COMMANDS = { "gri", "grichelde" }
+
+Grichelde.SUPPORTED_CHAT_COMMANDS = {
+    ["/s"]               = "SAY",
+    ["/say"]             = "SAY",
+    ["/sprechen"]        = "SAY",
+    ["/c"]               = "CHANNEL",
+    ["/csay"]            = "CHANNEL",
+    ["/e"]               = "EMOTE",
+    ["/em"]              = "EMOTE",
+    ["/me"]              = "EMOTE",
+    ["/emote"]           = "EMOTE",
+    ["/y"]               = "YELL",
+    ["/yell"]            = "YELL",
+    ["/sh"]              = "YELL",
+    ["/shout"]           = "YELL",
+    ["/schreien"]        = "YELL",
+    ["/sch"]             = "YELL",
+    ["/p"]               = "PARTY",
+    ["/party"]           = "PARTY",
+    ["/gruppe"]          = "PARTY",
+    ["/pl"]              = "PARTY",
+    ["/partyleader"]     = "PARTY",
+    ["/g"]               = "GUILD",
+    ["/gc"]              = "GUILD",
+    ["/guild"]           = "GUILD",
+    ["/gilde"]           = "GUILD",
+    ["/o"]               = "OFFICER",
+    ["/osay"]            = "OFFICER",
+    ["/officer"]         = "OFFICER",
+    ["/offizier"]        = "OFFICER",
+    ["/raid"]            = "RAID",
+    ["/rsay"]            = "RAID",
+    ["/rl"]              = "RAID",
+    ["/rsay"]            = "RAID",
+    ["/raidleader"]      = "RAID",
+    ["/schlachtzug"]     = "RAID",
+    ["/rw"]              = "RAID_WARNING",
+    ["/raidwarning"]     = "RAID_WARNING",
+    ["/i"]               = "INSTANCE_CHAT",
+    ["/instance"]        = "INSTANCE_CHAT",
+    ["/instanz"]         = "INSTANCE_CHAT",
+    ["/bg"]              = "BATTLEGROUND",
+    ["/battleground"]    = "BATTLEGROUND",
+    ["/schlachfeld"]     = "BATTLEGROUND",
+    ["/w"]               = "WHISPER",
+    ["/whisper"]         = "WHISPER",
+    ["/t"]               = "WHISPER",
+    ["/tell"]            = "WHISPER",
+    ["/send"]            = "WHISPER",
+    ["/tt"]              = "WHISPER",
+    ["/r"]               = "WHISPER",
+    ["/reply"]           = "WHISPER",
+    ["/fl\195\188stern"] = "WHISPER",
+    ["/antworten"]       = "WHISPER",
+}
+
+Grichelde.BLIZZ_TYPE_TO_OPTIONS = {
+    ["SAY"]          = "say",
+    ["EMOTE"]        = "emote",
+    ["YELL"]         = "yell",
+    ["PARTY"]        = "party",
+    ["GUILD"]        = "guild",
+    ["OFFICER"]      = "officer",
+    ["RAID"]         = "raid",
+    ["RAID_WARNING"] = "raidWarning",
+    ["INSTANCE"]     = "instance",
+    ["BATTLEGROUND"] = "battleground",
+    ["WHISPER"]      = "whisper",
+}
+
+-- do not replace these patterns
+Grichelde.IGNORE_PATTERNS = {
+    LINKS = {
+        "|[Cc]%x%x%x%x%x%x%x%x.-|r", -- colored items (or links)
+        "|H.-|h",     -- item links (http://www.wowwiki.com/ItemLink)
+        "|T.-|t",     -- textures
+        "|K.-|k",     -- Battle.net
+        "|n",         -- newline
+    },
+    EMOTES = {
+        "%*.-%*",     -- emotes *
+        "%*%*.-%*%*", -- emotes **
+        "%<.-%>",     -- emotes < >
+    },
+    SUBSTITUTES = {
+        "%%n",   -- player's name
+        "%%z",   -- player's currnt zone
+        "%%sz",  -- player's current sub-zone
+        "%%loc", -- player's map coordinates
+        "%%t",   -- name of target
+        "%%f",   -- name of focus target
+        "%%m",   -- name of mouseover unit
+        "%%p",   -- name of player pet
+        "%%tt",  -- name of player's target's target
+    },
+    RAID_TARGETS = {
+        "{rt[1-8]}", -- rumbered raid target icons, localized raid targets are handled differently
+    },
+    LOCALIZED_RAID_TARGETS = {
+        "Star",
+        "Circle",
+        "Diamond",
+        "Triangle",
+        "Moon",
+        "Square",
+        "Cross",
+        "Skull",
+    },
+    OOC_BRACKETS = {
+        "%(%(.-%)%)",           -- (( ... ))
+        "%(%s*ooc[%:%s].-%)",   -- ( ooc )
+    },
+    OOC_NO_BRACKETS = {
+        "ooc[%:%s]",
+    },
+}
 
 local function nilOrEmpty(s)
     return s == nil or s:trim() == ""
@@ -45,22 +170,22 @@ local function spairs(t, orderFunc)
     -- collect the keys
     local sortedKeys = {}
     -- for every non-nil value
-    for key, _ in Grichelde.functions.pairs(t) do
+    for key, _ in Grichelde.F.pairs(t) do
-        Grichelde.functions.tInsert(sortedKeys, key)
+        Grichelde.F.tInsert(sortedKeys, key)
     end
 
-    if orderFunc then
+    if (orderFunc ~= nil) then
-        Grichelde.functions.tSort(sortedKeys, function(a, b) return orderFunc(sortedKeys, a, b) end)
+        Grichelde.F.tSort(sortedKeys, function(a, b) return orderFunc(sortedKeys, a, b) end)
     else
         -- lexicographical order
-        Grichelde.functions.tSort(sortedKeys)
+        Grichelde.F.tSort(sortedKeys)
     end
 
     -- return the iterator function
     local it = 0
     return function()
         it = it + 1
-        if sortedKeys[it] then
+        if (sortedKeys[it] ~= nil) then
             return sortedKeys[it], t[sortedKeys[it]]
         else
             return nil
@@ -68,12 +193,25 @@ local function spairs(t, orderFunc)
     end
 end
 
-local function tFilter(t, cond, extr)
+local function tFilter(t, condition, extract)
     local filtered = {}
-    for key, value in Grichelde.functions.pairs(t) do
+    for key, value in Grichelde.F.pairs(t) do
-        if cond(key, value) then
+        local cond = false
-            local val = extr(key, value)
+        if (condition) then
-            Grichelde.functions.tInsert(filtered, #filtered + 1, val)
+            local t = Grichelde.F.type(condition)
+            if (t == "function") then
+                cond = condition(t, key, value)
+            elseif (t == "string") or (t == "number") then
+                cond = (value == condition)
+            end
+        end
+
+        if (cond) then
+            local val = value
+            if (extract and (Grichelde.F.type(extract) == "function")) then
+                val = extract(t, key, value)
+            end
+            Grichelde.F.tInsert(filtered, val)
         end
     end
     return filtered
@@ -81,92 +219,224 @@ end
 
 local function tSize(t)
     local size = 0
-    if (t) then
+    if (t ~= nil) then
         -- for every non-nil value
-        for _, _ in Grichelde.functions.pairs(t) do
+        for _, _ in Grichelde.F.pairs(t) do
             size = size + 1
         end
     end
     return size
 end
 
+local function tIsEmpty(t)
+    if (not t) then return true end
+    return Grichelde.F.tNext(t) == nil
+end
+
 local function tClone(orig)
-    local orig_type = Grichelde.functions.type(orig)
+    local orig_type = Grichelde.F.type(orig)
     local copy
-    if orig_type == 'table' then
+    if (orig_type == 'table') then
         copy = {}
         -- for every non-nil value
-        for orig_key, orig_value in Grichelde.functions.tNext, orig, nil do
+        for orig_key, orig_value in Grichelde.F.tNext, orig, nil do
             copy[tClone(orig_key)] = tClone(orig_value)
         end
-        Grichelde.functions.setmetatable(copy, tClone(Grichelde.functions.getmetatable(orig)))
+        Grichelde.F.setmetatable(copy, tClone(Grichelde.F.getmetatable(orig)))
     else -- number, string, boolean, etc
         copy = orig
     end
     return copy
 end
 
-local function isChar(word)
+local function getNextCharUtf8(word)
-    return Grichelde.functions.find(word, "%a+")
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return nil, nil
+    end
+
+    local wordLength = Grichelde.F.length(word)
+    local c1 = Grichelde.F.toByte(word, 1)
+    if (c1 > 0) and (c1 <= 127) then
+        -- UTF8-1
+        return Grichelde.F.bytes2Char(c1), Grichelde.F.sub(word, 2)
+    elseif (c1 >= 194) and (c1 <= 223) then
+        -- UTF8-2
+        Grichelde.F.assert(wordLength >= 2, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        return Grichelde.F.bytes2Char(c1, c2), Grichelde.F.sub(word, 3)
+    elseif (c1 >= 224) and (c1 <= 239) then
+        -- UTF8-3
+        Grichelde.F.assert(wordLength >= 3, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        local c3 = Grichelde.F.toByte(word, 3)
+        return Grichelde.F.bytes2Char(c1, c2, c3), Grichelde.F.sub(word, 4)
+    elseif (c1 >= 240) and (c1 <= 244) then
+        -- UTF8-4
+        Grichelde.F.assert(wordLength >= 4, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        local c3 = Grichelde.F.toByte(word, 3)
+        local c4 = Grichelde.F.toByte(word, 4)
+        return Grichelde.F.bytes2Char(c1, c2, c3, c4), Grichelde.F.sub(word, 5)
+    else
+        return nil, nil
+    end
+end
+
+local function isLetter(word)
+    local char = Grichelde.F.getNextCharUtf8(word)
+    return (char ~= nil) and (Grichelde.F.toUpper(char) ~= Grichelde.F.toLower(char))
 end
 
 local function isNumber(digit)
-    return Grichelde.functions.find(digit, "%d+")
+    if ((digit == nil) or (Grichelde.F.type(digit) ~= "string") or (Grichelde.F.length(digit) < 1)) then
+        return false
+    else
+        return Grichelde.F.find(digit, "%d+") ~= nil
+    end
 end
 
 local function isUpper(word)
-    return Grichelde.functions.isChar(word) and word == Grichelde.functions.toUpper(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return false
+    elseif (Grichelde.F.toUpper(word) == Grichelde.F.toLower(word)) then
+        return false
+    else
+        return word == Grichelde.F.toUpper(word)
+    end
 end
 
 local function isLower(word)
-    return Grichelde.functions.isChar(word) and word == Grichelde.functions.toLower(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return false
+    elseif (Grichelde.F.toUpper(word) == Grichelde.F.toLower(word)) then
+        return false
+    else
+        return word == Grichelde.F.toLower(word)
+    end
 end
 
 local function isCapital(word)
-    return Grichelde.functions.legnth(word) > 1
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
-        and Grichelde.functions.isUpper(Grichelde.functions.sub(word,1,1))
+        return false
-        and Grichelde.functions.isLower(Grichelde.functions.sub(word,2))
+    else
+        local first, rest = Grichelde.F.getNextCharUtf8(word)
+        local isCapital = Grichelde.F.isUpper(first)
+        if (rest ~= nil) then
+            return isCapital and Grichelde.F.isLower(rest)
+        else
+           return isCapital
+        end
+    end
+end
+
+local function capitalize(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return ""
+    else
+        local first, rest = Grichelde.F.getNextCharUtf8(word)
+        local capital = Grichelde.F.toUpper(first)
+        if (rest ~= nil) then
+            return capital .. Grichelde.F.toLower(rest)
+        else
+           return capital
+        end
+    end
+end
+
+local function color(color, text)
+    return color .. text .. Grichelde.COLOR_CODES.CLOSE
+end
+
+local function cPrefix(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.PREFIX, text)
+end
+
+local function cYellow(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.NORMAL, text)
+end
+
+local function cGray(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.GRAY, text)
+end
+
+local function cDarkgray(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.DARKGRAY, text)
+end
+
+local function cGreen(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.GREEN, text)
+end
+
+local function cOrange(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.ORANGE, text)
+end
+
+local function cRed(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.RED, text)
+end
+
+local function cHyperlink(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.HYPERLINK, text)
 end
 
 -- faster function lookups by mapping to local refs
-Grichelde.functions = {}
+Grichelde.F = {
-Grichelde.functions.IsAddOnLoaded = _G.IsAddOnLoaded
+    IsAddOnLoaded   = _G.IsAddOnLoaded,
-Grichelde.functions.type          = _G.type
+    assert          = _G.assert,
-Grichelde.functions.print         = _G.print
+    type            = _G.type,
-Grichelde.functions.nilOrEmpty    = nilOrEmpty
+    print           = _G.print,
-Grichelde.functions.pairs         = _G.pairs
+    nilOrEmpty      = nilOrEmpty,
-Grichelde.functions.ipairs        = _G.ipairs
+    pairs           = _G.pairs,
-Grichelde.functions.spairs        = spairs
+    ipairs          = _G.ipairs,
-Grichelde.functions.tContains     = _G.tContains
+    spairs          = spairs,
-Grichelde.functions.tFilter       = tFilter
+    tContains       = _G.tContains,
-Grichelde.functions.tInsert       = _G.table.insert
+    tFilter         = tFilter,
-Grichelde.functions.tConcat       = _G.table.concat
+    tInsert         = _G.table.insert,
-Grichelde.functions.tSize         = tSize
+    tConcat         = _G.table.concat,
-Grichelde.functions.tSort         = _G.table.sort
+    tSize           = tSize,
-Grichelde.functions.tClone        = tClone
+    tIsEmpty        = tIsEmpty,
-Grichelde.functions.tNext         = _G.next
+    tSort           = _G.table.sort,
-Grichelde.functions.setmetatable  = _G.setmetatable
+    tClone          = tClone,
-Grichelde.functions.getmetatable  = _G.getmetatable
+    tNext           = _G.next,
-Grichelde.functions.select        = _G.select
+    tWipe           = _G.wipe,
-Grichelde.functions.unpack        = _G.unpack
+    setmetatable    = _G.setmetatable,
-Grichelde.functions.find          = _G.string.find
+    getmetatable    = _G.getmetatable,
-Grichelde.functions.sub           = _G.string.sub
+    select          = _G.select,
-Grichelde.functions.gsub          = _G.string.gsub
+    unpack          = _G.unpack,
-Grichelde.functions.match         = _G.strmatch
+    find            = _G.string.find,
-Grichelde.functions.join          = _G.strjoin
+    sub             = _G.string.sub,
-Grichelde.functions.split         = _G.strsplit
+    gsub            = _G.string.gsub,
-Grichelde.functions.toUpper       = _G.strupper
+    match           = _G.strmatch,
-Grichelde.functions.toLower       = _G.strlower
+    gmatch          = _G.string.gmatch,
-Grichelde.functions.isChar        = isChar
+    join            = _G.strjoin,
-Grichelde.functions.isNumber      = isNumber
+    split           = _G.strsplit,
-Grichelde.functions.isUpper       = isUpper
+    toUpper         = _G.strupper,
-Grichelde.functions.isLower       = isLower
+    toLower         = _G.strlower,
-Grichelde.functions.isCapital     = isCapital
+    getNextCharUtf8 = getNextCharUtf8,
-Grichelde.functions.format        = _G.string.format
+    isLetter        = isLetter,
-Grichelde.functions.rep           = _G.string.rep
+    isNumber        = isNumber,
-Grichelde.functions.trim          = _G.strtrim
+    isUpper         = isUpper,
-Grichelde.functions.length        = _G.string.len
+    isLower         = isLower,
-Grichelde.functions.toString      = _G.tostring
+    isCapital       = isCapital,
-Grichelde.functions.toNumber      = _G.tonumber
+    capitalize      = capitalize,
-Grichelde.functions.max           = _G.math.max
+    color           = color,
-Grichelde.functions.min           = _G.math.min
+    cPrefix         = cPrefix,
+    cYellow         = cYellow,
+    cGray           = cGray,
+    cDarkgray       = cDarkgray,
+    cGreen          = cGreen,
+    cOrange         = cOrange,
+    cRed            = cRed,
+    cHyperlink      = cHyperlink,
+    toByte          = _G.string.byte,
+    bytes2Char      = _G.string.char,
+    format          = _G.string.format,
+    rep             = _G.string.rep,
+    trim            = _G.strtrim,
+    length          = _G.string.len,
+    lengthUtf8      = _G.strlenutf8,
+    toString        = _G.tostring,
+    toNumber        = _G.tonumber,
+    max             = _G.math.max,
+    min             = _G.math.min,
+}

GricheldeDatabase.lua

@@ -1,11 +1,11 @@
 -- read namespace from global env
 local _G = _G
-local Grichelde = _G.Grichelde
+local Grichelde = _G.Grichelde or {}
 
-local pairs, tInsert, tClone, unpack, join, toString
+local pairs, tInsert, tClone, tWipe, unpack, join, toString
-    = Grichelde.functions.pairs, Grichelde.functions.tInsert, Grichelde.functions.tClone, Grichelde.functions.unpack, Grichelde.functions.join, Grichelde.functions.toString
+    = Grichelde.F.pairs, Grichelde.F.tInsert, Grichelde.F.tClone, Grichelde.F.tWipe, Grichelde.F.unpack, Grichelde.F.join, Grichelde.F.toString
 
-function Grichelde:GetDefaultConfig()
+function Grichelde.getDefaultConfig()
     return {
         global = {},
         profile = {
@@ -24,46 +24,60 @@ function Grichelde:GetDefaultConfig()
             },
             replacements = {
                 ["**"] = {
-                    order = 9999,
+                    order = 999,
                     searchText = "",
                     replaceText = "",
                     exactCase = false,
                     consolidate = true,
+                    matchWhen = 2,
+                    stopOnMatch = false,
                 },
-                replacement_10 = {
-                    order = 10,
-                    searchText = "s",
-                    replaceText = "ch",
-                    exactCase = false,
-                    consolidate = true,
-                },
-                replacement_11 = {
-                    order = 11,
-                    searchText = "t",
-                    replaceText = "ck",
-                    exactCase = false,
-                    consolidate = true,
-                },
-                replacement_12 = {
-                    order = 12,
-                    searchText = "Zark",
-                    replaceText = "toter Schamane",
-                    exactCase = false,
-                    consolidate = true,
-                }
             }
         }
     }
 end
 
-function Grichelde:LoadDatabase()
+function Grichelde.getDefaultSampleMappings()
-    local db = LibStub("AceDB-3.0"):New(self.name .."DB", self:GetDefaultConfig(), true)
+    return {
+        replacement_10 = {
+            order = 10,
+            searchText = "s",
+            replaceText = "ch",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        },
+        replacement_11 = {
+            order = 11,
+            searchText = "t",
+            replaceText = "ck",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        },
+        replacement_12 = {
+            order = 12,
+            searchText = "p",
+            replaceText = "b",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        }
+    }
+end
 
-    db.RegisterCallback(self, "OnNewProfile", "RefreshOptions")
+function Grichelde:LoadDatabase()
-    db.RegisterCallback(self, "OnProfileChanged", "RefreshOptions")
+    local db = LibStub("AceDB-3.0"):New(self.name .."DB", self.getDefaultConfig(), true)
-    db.RegisterCallback(self, "OnProfileDeleted", "RefreshOptions")
+
-    db.RegisterCallback(self, "OnProfileCopied", "RefreshOptions")
+    db.RegisterCallback(self, "OnNewProfile", "RefreshProfiles")
-    db.RegisterCallback(self, "OnProfileReset", "RefreshOptions")
+    db.RegisterCallback(self, "OnProfileChanged", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileDeleted", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileCopied", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileReset", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileShutdown", "RefreshProfiles")
 
     return db
 end
@@ -77,8 +91,8 @@ function Grichelde:SyncToDatabase(info, val)
     local option = self.db.profile
     local path = 1
     while (path < #info) do
-        if info[path] ~= "mappings" then
+        if (info[path] ~= "mappings") then
-            option = option[info[path]] -- or nil
+            option = option[info[path]]
         end
         path = path + 1
     end
@@ -96,8 +110,8 @@ function Grichelde:ReadFromDatabase(info)
     local option = self.db.profile
     local path = 1
     while (path <= #info) do
-        if info[path] ~= "mappings" then
+        if (info[path] ~= "mappings") then
-            option = option[info[path]] -- or nil
+            option = option[info[path]]
         end
         path = path + 1
     end
@@ -108,15 +122,15 @@ end
 
 --- Sorts a replacements table by order sub-field and rename.
 --- Do NOT reassign self.db.profile.replacements here or with its output as it will break defaults
-function Grichelde:ReorderReplacements()
+function Grichelde:ReorderReplacements(replacements)
-    local replacements = self.db.profile.replacements or {}
+    local repls = replacements or self.db.profile.replacements or {}
 
     self:TracePrint("ReorderReplacements : unsorted table")
-    self:TracePrint(replacements)
+    self:TracePrint(repls)
 
     local orderToName = {}
     local size = 0
-    for replName, replTable in pairs(replacements) do
+    for replName, replTable in pairs(repls) do
         size = size + 1
         tInsert(orderToName, replTable.order, replName)
     end
@@ -129,31 +143,19 @@ function Grichelde:ReorderReplacements()
 
     while count < size do
         local replName = orderToName[index]
-        if replName and replacements[replName] then
+        if (replName ~= nil) and (repls[replName] ~= nil) then
             self:TracePrint("ReorderReplacements : replName: %s, replTable", replName)
-            self:TracePrint(replacements[replName])
+            self:TracePrint(repls[replName])
             local order = Grichelde.MAPPING_OFFSET + count
-            sorted["replacement_" .. order] = tClone(replacements[replName])
+            sorted["replacement_" .. order] = tClone(repls[replName])
             sorted["replacement_" .. order].order = order
             count = count + 1
         end
         index = index + 1
-        if ( index > 10000) then break end
+        if (index > 999) then break end
     end
 
 --  self:TracePrint("ReorderReplacements : sorted")
 --  self:TracePrint(sorted)
-
+    return sorted
-    -- do NOT set self.db.profile.replacements = {} it will break defaults
-    for replName, _ in pairs(replacements) do
-        replacements[replName] = nil
-    end
-
-    -- copy over sorted replacements
-    for replName, replTable in pairs(sorted) do
-        replacements[replName] = replTable
-    end
-
-    self:DebugPrint("ReorderReplacements : sorted table")
-    self:DebugPrint(self.db.profile.replacements)
 end

GricheldeMinimap.lua

@@ -0,0 +1,146 @@
+-- read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local cPrefix, cGreen, cRed
+    = Grichelde.F.cPrefix, Grichelde.F.cGreen, Grichelde.F.cRed
+
+
+--- add Minimap button
+function Grichelde:MinimapButton()
+    local function clickHandler(_, button)
+        if (button == "LeftButton") then
+            self:ToggleOptions()
+        elseif (button == "RightButton") then
+            self:ToggleActivation()
+        end
+    end
+
+    local function updateTooltip(tooltip)
+        if (tooltip == nil) or (tooltip.AddLine == nil) then return end
+
+        local tooltipTitle = self:Format(self.L.Minimap_Tooltip_Enabled, self.L.AddonName)
+        if not self.db.profile.enabled then
+            tooltipTitle = self:Format(self.L.Minimap_Tooltip_Disabled, self.L.AddonName)
+        end
+
+        tooltip:SetText(tooltipTitle,
+            Grichelde.COLORS.HIGHLIGHT.r, Grichelde.COLORS.HIGHLIGHT.g, Grichelde.COLORS.HIGHLIGHT.b, Grichelde.COLORS.HIGHLIGHT.a
+        )
+
+        tooltip:AddDoubleLine(self.L.Minimap_Tooltip_Options_Left, self.L.Minimap_Tooltip_Options_Right,
+            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
+            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
+        )
+        tooltip:AddDoubleLine(self.L.Minimap_Tooltip_Mappings_Left, self.L.Minimap_Tooltip_Mappings_Right,
+            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
+            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
+        )
+    end
+
+    local darkened = Grichelde.MINIMAP_ENABLED
+    if (self.db.profile.enabled == false) then
+        darkened = Grichelde.MINIMAP_DARKENDED
+    end
+
+    local ldb = LibStub("LibDataBroker-1.1"):NewDataObject(self.name, {
+        type = "launcher",
+        text = self.AddonName,
+        icon = "Interface\\Icons\\Spell_Holy_Silence",
+        --icon = ([[Interface\Addons\%s\%s]]):format(self.name, self.name),
+        OnClick = clickHandler,
+        OnRightClick = function() self:ShowMappings() end,
+        OnTooltipShow = updateTooltip,
+        iconR = darkened,
+        iconG = darkened,
+        iconB = darkened
+    })
+
+    local icon = LibStub("LibDBIcon-1.0")
+    self:DebugPrint("MinimapButton : hidden: ", self.db.profile.minimapButton.hide)
+    icon:Register(self.name, ldb, self.db.profile.minimapButton)
+
+    return ldb, icon
+end
+
+function Grichelde:ToggleMinimapButton()
+    self.db.profile.minimapButton.hide = not self.db.profile.minimapButton.hide
+    self:DebugPrint("ToggleMinimapButton : hidden: ", self.db.profile.minimapButton.hide)
+
+    if (self.db.profile.minimapButton.hide == true) then
+        self:HideMinimapButton()
+    else
+        self:ShowMinimapButton()
+    end
+end
+
+function Grichelde:ShowMinimapButton()
+    if (self.icon ~= nil) then
+        self.icon:Show(self.name)
+    end
+end
+
+function Grichelde:HideMinimapButton()
+    if (self.icon ~= nil) then
+        self.icon:Hide(self.name)
+    end
+end
+
+function Grichelde:ToggleActivation()
+    if (self.db.profile.enabled == true) then
+        if (self.dialog == nil) or (self.dialog.OpenFrames[self.name] == nil) then
+            self:PrefixedPrint(self.L.Profiles_Deactivated, cRed(self.db:GetCurrentProfile()))
+        end
+        self:Deactivate()
+    else
+        if (self.dialog == nil) or (self.dialog.OpenFrames[self.name] == nil) then
+            self:PrefixedPrint(self.L.Profiles_Activated, cGreen(self.db:GetCurrentProfile()))
+        end
+        self:Activate()
+    end
+end
+
+function Grichelde:RefreshMinimap()
+    if (self.db.profile.enabled == true) then
+        self:Activate()
+    else
+        self:Deactivate()
+    end
+end
+
+function Grichelde:Activate()
+    self.db.profile.enabled = true
+
+    -- refresh option UI if open at the moment
+    if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
+        self.dialog:SelectGroup(self.name)
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        local statusText = self:Format(self.L.AddonLoaded, namePlusVersion)
+        self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
+    end
+
+    if (self.ldb ~= nil) then
+        self.ldb.iconR = Grichelde.MINIMAP_ENABLED
+        self.ldb.iconG = Grichelde.MINIMAP_ENABLED
+        self.ldb.iconB = Grichelde.MINIMAP_ENABLED
+    end
+end
+
+function Grichelde:Deactivate()
+    self.db.profile.enabled = false
+
+    -- refresh option UI if open at the moment
+    if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
+        self.dialog:SelectGroup(self.name)
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        local statusText = self:Format(self.L.AddonUnloaded, namePlusVersion)
+        self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
+    end
+
+    if (self.ldb ~= nil) then
+        self.ldb.iconR = Grichelde.MINIMAP_DARKENDED
+        self.ldb.iconG = Grichelde.MINIMAP_DARKENDED
+        self.ldb.iconB = Grichelde.MINIMAP_DARKENDED
+    end
+end
+

GricheldeOptions.lua

@@ -1,9 +1,11 @@
 -- read namespace from global env
 local _G = _G
-local Grichelde = _G.Grichelde
+local Grichelde = _G.Grichelde or {}
 
-local nilOrEmpty, pairs, find, match, toString, toNumber
+local assert, nilOrEmpty, pairs, ipairs, spairs, tContains, tInsert, tClone, tWipe, find, match, cPrefix, cGray, cGreen, cOrange, cRed, format, toString, toNumber
-    = Grichelde.functions.nilOrEmpty, Grichelde.functions.pairs, Grichelde.functions.find, Grichelde.functions.match, Grichelde.functions.toString, Grichelde.functions.toNumber
+    = Grichelde.F.assert, Grichelde.F.nilOrEmpty, Grichelde.F.pairs, Grichelde.F.ipairs, Grichelde.F.spairs, Grichelde.F.tContains, Grichelde.F.tInsert, Grichelde.F.tClone, Grichelde.F.tWipe, Grichelde.F.find, Grichelde.F.match, Grichelde.F.cPrefix, Grichelde.F.cGray, Grichelde.F.cGreen, Grichelde.F.cOrange, Grichelde.F.cRed, Grichelde.F.format, Grichelde.F.toString, Grichelde.F.toNumber
+
+local selectedExample = 1
 
 function Grichelde:CreateOptionsUI()
     return {
@@ -20,6 +22,7 @@ function Grichelde:CreateOptionsUI()
                 type = "toggle",
                 name = self.L.Options_Enabled_Name,
                 desc = self:Format(self.L.Options_Enabled_Desc, self.L.AddonName),
+                set = function() self:ToggleActivation() end,
                 disabled = false,
             },
             minimapButton = {
@@ -27,25 +30,62 @@ function Grichelde:CreateOptionsUI()
                 type = "toggle",
                 name = self.L.Options_Minimap_Button_Name,
                 desc = self.L.Options_Minimap_Button_Desc,
-                set = function(info, val) self:ToogleMinimapButton(info, val) end,
+                set = function(_, _) self:ToggleMinimapButton() end,
-                get = function(info) return not self.db.profile.minimapButton.hide end,
+                get = function(_) return not self.db.profile.minimapButton.hide end,
                 disabled = false,
             },
-            channels = {
+
+            replacements = {
                 order = 2,
                 type = "group",
+                name = self.L.Options_Replacements_Group_Name,
+                desc = self.L.Options_Replacements_Group_Desc,
+                args = {
+                    add = {
+                        order = 0,
+                        type = "execute",
+                        confirm = false,
+                        name = self.L.Options_Replacements_Add_Name,
+                        desc = self.L.Options_Replacements_Add_Desc,
+                        func = function(info) self:AddEmptyMapping(info) end,
+                    },
+                    deleteAll = {
+                        order = 1,
+                        type = "execute",
+                        confirm = true,
+                        confirmText = self.L.Options_Replacements_DeleteAll_ConfirmText,
+                        name = self.L.Options_Replacements_DeleteAll_Name,
+                        desc = self.L.Options_Replacements_DeleteAll_Desc,
+                        func = function(info) self:DeleteAllMappings(info) end,
+                    },
+                    header = {
+                        order = 3,
+                        type = "description",
+                        name = self.L.Options_Replacements_Header,
+                    },
+                    spacer1 = {
+                        order = 4,
+                        type = "header",
+                        name = "",
+                    },
+                },
+            },
+
+            channels = {
+                order = 3,
+                type = "group",
                 name = self.L.Options_Channels_Group_Name,
                 desc = self:Format(self.L.Options_Channels_Group_Desc, self.L.AddonName),
                 args = {
                     header = {
                         order = 1,
                         type = "description",
-                        name = self.L.Options_Channels_Header
+                        name = self.L.Options_Channels_Header,
                     },
-                    spacer = {
+                    spacer2 = {
                         order = 2,
                         type = "header",
-                        name = ""
+                        name = "",
                     },
                     say = {
                         order = 10,
@@ -113,45 +153,131 @@ function Grichelde:CreateOptionsUI()
                         name = self.L.Options_Channel_Whisper_Name,
                         desc = self:Format(self.L.Options_Channel_Whisper_Desc, self.L.AddonName),
                     },
-                }
+                },
             },
 
-            replacements = {
+            help = {
-                order = 3,
+                order = -1,
                 type = "group",
-                name = self.L.Options_Replacements_Group_Name,
+                childGroups = "tab",
-                desc = self.L.Options_Replacements_Group_Desc,
+                name = self.L.Options_Help_Group_Name,
+                desc = self.L.Options_Help_Group_Desc,
+                disabled = false,
                 args = {
-                    add = {
+                    info = {
-                        order = 0,
+                        order = 10,
-                        type = "execute",
+                        type = "group",
-                        confirm = false,
+                        name = self.L.Options_Help_Tab_Info_Name,
-                        name = self.L.Options_Replacements_Add_Name,
+                        desc = self.L.Options_Help_Tab_Info_Desc,
-                        desc = self.L.Options_Replacements_Add_Desc,
+                        args = {
-                        func = function(info) self:AddEmptyMapping(info) end
+                            paragraph1 = {
+                                order = 1,
+                                type = "description",
+                                name = self:Format(self.L.Options_Help_Info, self.L.AddonName),
+                                fontSize = "medium",
+                            },
+                        },
                     },
-                    deleteAll = {
+                    basics = {
-                        order = 1,
+                        order = 11,
-                        type = "execute",
+                        type = "group",
-                        confirm = true,
+                        name = self.L.Options_Help_Tab_Basics_Name,
-                        confirmText = self.L.Options_Replacements_DeleteAll_ConfirmText,
+                        desc = self.L.Options_Help_Tab_Basics_Desc,
-                        name = self.L.Options_Replacements_DeleteAll_Name,
+                        args = {
-                        desc = self.L.Options_Replacements_DeleteAll_Desc,
+                            paragraph1 = {
-                        func = function(info) self:DeleteAllMappings(info) end
+                                order = 1,
+                                type = "description",
+                                name = self.L.Options_Help_Basics,
+                                fontSize = "medium",
+                            },
+                        },
                     },
-                    header = {
+                    expert = {
-                        order = 3,
+                        order = 12,
+                        type = "group",
+                        name = self.L.Options_Help_Tab_Expert_Name,
+                        desc = self.L.Options_Help_Tab_Expert_Desc,
+                        args = {
+                            paragraph4 = {
+                                order = 1,
+                                type = "description",
+                                name = self.L.Options_Help_Expert,
+                                fontSize = "medium",
+                            },
+                        },
+                    },
+                    examples = {
+                        order = 13,
+                        type = "group",
+                        name = self.L.Options_Help_Tab_Examples_Name,
+                        desc = self.L.Options_Help_Tab_Examples_Desc,
+                        args = {
+                            note = {
+                                order = 1,
+                                type = "description",
+                                name = self.L.Options_Help_Examples_Note,
+                            },
+                            header = {
+                                order = 2,
+                                type = "description",
+                                name = self.L.Options_Help_Examples_Header,
+                                fontSize = "medium",
+                                width = 2.1
+                            },
+                            dropDown = {
+                                order = 3,
+                                type = "select",
+                                name = "",
+                                width = 1.2,
+                                values = function(_) return self:ExtractExampleNames() end,
+                                set = function(_, val) selectedExample = val end,
+                                get = function(_)
+                                    self.options.args.help.args.examples.args.header.name = self.L.Options_Help_Examples[selectedExample].desc
+                                    self.options.args.help.args.examples.args.example.name = self:ExtractExampleCodes(selectedExample),
+                                    self.dialog:SelectGroup(self.name, "help", "examples", "header.name")
+                                    return selectedExample
+                                end,
+                            },
+
+                            spacer3 = {
+                                order = 3,
+                                type = "description",
+                                name = "",
+                                desc = "",
+                                width = 2.3,
+                            },
+                            import = {
+                                order = 4,
+                                type = "execute",
+                                width = 1,
+                                confirm = selectedExample > 0,
+                                name = self.L.Options_Help_Examples_Import_Name,
+                                -- desc = self.L.Options_Help_Examples_Import_Desc,
+                                desc = function() return format(self.L.Options_Help_Examples_Import_Desc, cPrefix(self.L.Options_Help_Examples[selectedExample].name)) end,
+                                func = function(info) self:ImportExample(selectedExample) end,
+                            },
+
+                            spacer4 = {
+                                order = 6,
+                                type = "header",
+                                name = "",
+                            },
+                            example = {
+                                order = 7,
+                                type = "description",
+                                name = self.L.Options_Help_Examples_Text,
+                                fontSize = "medium",
+                            },
+                        },
+                    },
+                    disclaimer = {
+                        order = 14,
                         type = "description",
-                        name = self.L.Options_Replacements_Header
+                        name = self.L.Options_Help_Disclaimer,
                     },
-                    spacer = {
+                },
-                        order = 4,
+            },
-                        type = "header",
+        },
-                        name = ""
-                    },
-                }
-            }
-        }
     }
 end
 
@@ -162,77 +288,128 @@ function Grichelde:CreateMapping(offset)
         name = function(info) return self:MappingName(info) end,
         desc = self.L.Options_Mapping_Group_Desc,
         childGroups = "tree",
+        disabled = function(info) return not self:IsMappingActive(info) end,
         args = {
-            searchText = {
+            moveUp = {
                 order = 0,
+                type = "execute",
+                name = "",
+                desc = self.L.Options_Mapping_MoveUp_Desc,
+                image = function(info) return self:GetMoveUpImage(info) end,
+                width = 0.15,
+                func = function(info) self:MoveUp(info) end,
+            },
+            moveDown = {
+                order = 1,
+                type = "execute",
+                name = "",
+                desc = self.L.Options_Mapping_MoveDown_Desc,
+                image = function(info) return self:GetMoveDownImage(info) end,
+                width = 0.15,
+                func = function(info) self:MoveDown(info) end,
+            },
+            spacer5 = {
+                order = 2,
+                type = "description",
+                name = "",
+                desc = "",
+                width = 0.05,
+            },
+--[[
+            active = {
+                order = 3,
+                type = "toggle",
+                name = self.L.Options_Mapping_Enabled_Name,
+                desc = self.L.Options_Mapping_Enabled_Desc,
+                width = 2.2,
+            },
+]]
+            matchWhenLabel = {
+                order = 3,
+                type = "description",
+                name = self.L.Options_Mapping_MatchWhen_Name,
+                desc = self.L.Options_Mapping_MatchWhen_Desc,
+                fontSize = "medium",
+                width = 0.3,
+            },
+            matchWhen = {
+                order = 4,
+                type = "select",
+                name = " ",
+                desc = self.L.Options_Mapping_MatchWhen_Desc,
+                values = {
+                    self.L.Options_Mapping_MatchWhen_Select1,
+                    self.L.Options_Mapping_MatchWhen_Select2,
+                    self.L.Options_Mapping_MatchWhen_Select3,
+                    self.L.Options_Mapping_MatchWhen_Select4,
+                    self.L.Options_Mapping_MatchWhen_Select5,
+                    self.L.Options_Mapping_MatchWhen_Select6,
+                },
+                width = 1.4,
+            },
+            spacer6 = {
+                order = 5,
+                type = "description",
+                name = "",
+                desc = "",
+                width = 0.1,
+            },
+
+            delete = {
+                order = 6,
+                type = "execute",
+                confirm = true,
+                confirmText = self.L.Options_Mapping_Delete_ConfirmText,
+                name = "",
+                desc = self.L.Options_Mapping_Delete_Desc,
+                image = function(info) return self:GetDeleteImage(info) end,
+                width = 0.1,
+                func = function(info) self:DeleteMapping(info) end,
+            },
+
+            searchText = {
+                order = 10,
                 type = "input",
                 name = self.L.Options_Mapping_SearchText_Name,
                 desc = self.L.Options_Mapping_SearchText_Desc,
             },
             replaceText = {
-                order = 1,
+                order = 11,
                 type = "input",
                 name = self.L.Options_Mapping_ReplaceText_Name,
                 desc = self.L.Options_Mapping_ReplaceText_Desc,
             },
+
             exactCase = {
-                order = 2,
+                order = 21,
                 type = "toggle",
                 name = self.L.Options_Mapping_ExactCase_Name,
                 desc = self.L.Options_Mapping_ExactCase_Desc,
                 width = "full",
             },
             consolidate = {
-                order = 3,
+                order = 22,
                 type = "toggle",
                 name = self.L.Options_Mapping_Consolidate_Name,
                 desc = self.L.Options_Mapping_Consolidate_Desc,
-                width = "full"
+                width = "full",
-            },
-            moveUp = {
-                order = 10,
-                type = "execute",
-                -- name = self.L.Options_Mapping_MoveUp_Name,
-                name = "",
-                desc = self.L.Options_Mapping_MoveUp_Desc,
-                image = Grichelde.ICONS.MOVE_UP,
-                width = 0.15,
-                func = function(info) self:MoveUp(info) end
-            },
-            moveDown = {
-                order = 11,
-                type = "execute",
-                -- name = self.L.Options_Mapping_MoveDown_Name,
-                name = "",
-                desc = self.L.Options_Mapping_MoveDown_Desc,
-                image = Grichelde.ICONS.MOVE_DOWN,
-                width = 0.15,
-                func = function(info) self:MoveDown(info) end
-            },
-            spacer = {
-                order = 18,
-                type = "description",
-                name = "",
-                width = 1.2,
-            },
-            delete = {
-                order = 19,
-                type = "execute",
-                confirm = true,
-                confirmText = self.L.Options_Mapping_Delete_ConfirmText,
-                name = self.L.Options_Mapping_Delete_Name,
-                desc = self.L.Options_Mapping_Delete_Desc,
-                width = 0.5,
-                func = function(info) self:DeleteMapping(info) end
             },
+            stopOnMatch = {
+                order = 23,
+                type = "toggle",
+                name = self.L.Options_Mapping_StopOnMatch_Name,
+                desc = self.L.Options_Mapping_StopOnMatch_Desc,
+                width = "full",
+            }
         }
     }
 end
 
 function Grichelde:SetupOptions()
     -- add DB-backed profiles to UI options
-    local options = self:CreateOptionsUI()
+    local options = self:CreateOptionsUI(self)
     options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db)
+    options.args.profiles.order = 8
     options.args.profiles.disabled = false
 
     -- Adding options to blizzard frame
@@ -243,73 +420,53 @@ function Grichelde:SetupOptions()
     return options, dialog
 end
 
-function Grichelde:RefreshOptions(event)
+function Grichelde:RefreshProfiles(event, _, profileName)
-    self:DebugPrint("RefreshOptions : event:", event)
+    local function replaceReplacements(replacements)
-    if event == "OnNewProfile" then
+        -- do NOT set self.db.profile.replacements = {} it will break defaults
-        self:PrefixedPrint(self.L.Profiles_Created, self.COLOR_CODES.GREEN .. self.db:GetCurrentProfile() .. self.COLOR_CODES.CLOSE)
+        tWipe(self.db.profile.replacements)
-    elseif event == "OnProfileChanged" then
+
-        self:PrefixedPrint(self.L.Profiles_Loaded, self.COLOR_CODES.GREEN .. self.db:GetCurrentProfile() .. self.COLOR_CODES.CLOSE)
+        -- copy over sorted replacements
-    elseif event == "OnProfileDeleted" then
+        for replName, replTable in pairs(replacements) do
-        self:PrefixedPrint(self.L.Profiles_Deleted, self.COLOR_CODES.GREEN .. self.db:GetCurrentProfile() .. self.COLOR_CODES.CLOSE)
+            self.db.profile.replacements[replName] = replTable
-    elseif event == "OnProfileCopied" then
+        end
-        self:PrefixedPrint(self.L.Profiles_Copied, self.COLOR_CODES.GREEN .. self.db:GetCurrentProfile() .. self.COLOR_CODES.CLOSE)
+
-    elseif event == "OnProfileReset" then
+        self:DebugPrint("RefreshProfiles : reorderReplacements : sorted table")
-        self:PrefixedPrint(self.L.Profiles_Reset, self.COLOR_CODES.GREEN .. self.db:GetCurrentProfile() .. self.COLOR_CODES.CLOSE)
+        self:DebugPrint(self.db.profile.replacements)
+    end
+
+    local function addEmptyMappingWithoutRefresh()
+        self:DebugPrint("RefreshProfiles : addEmptyMappingWithoutRefresh")
+        self.db.profile.replacements.replacement_10.order = 10
+    end
+
+    self:DebugPrint("RefreshProfiles : event:", event)
+    --- AceDB will call OnProfileShutdown, OnProfileChanged and OnNewProfile in this order
+    if (event == "OnNewProfile") then
+        addEmptyMappingWithoutRefresh()
+        self:PrefixedPrint(self.L.Profiles_Created, cGreen(self.db:GetCurrentProfile()))
+    elseif (event == "OnProfileChanged") then
+        self:DebugPrint(self.L.Profiles_Loaded, cGreen(self.db:GetCurrentProfile()))
+    elseif (event == "OnProfileDeleted") then
+        self:PrefixedPrint(self.L.Profiles_Deleted, cRed(profileName))
+    elseif (event == "OnProfileCopied") then
+        self:DebugPrint(self.L.Profiles_Copied, cOrange(profileName))
+    elseif (event == "OnProfileReset") then
+        addEmptyMappingWithoutRefresh()
+        self:PrefixedPrint(self.L.Profiles_Reset, cOrange(self.db:GetCurrentProfile()))
     else
         self:DebugPrint("Refreshing Profile %s on options change: %s", self.db:GetCurrentProfile(), event)
     end
 
-    self:ReorderReplacements()
+    local repls = self:ReorderReplacements()
-    self:RefreshReplacements(self.db.profile.replacements)
+    replaceReplacements(repls)
+    self:RefreshOptions(repls)
+    self:RefreshDialog()
+    self:RefreshMinimap()
 end
 
---- add Minimap button
-function Grichelde:MinimapButton()
-    local function toggleOptionsUI(_, button)
-        if button == 'LeftButton' then
-            self:ToggleOptions()
-        elseif button == 'RightButton' then
-            self:ToogleMappings()
-        end
-    end
-
-    local function tooltip(tooltip)
-        if not tooltip or not tooltip.AddLine then return end
-        tooltip:SetText(self.L.AddonName,
-            Grichelde.COLORS.HIGHLIGHT.r, Grichelde.COLORS.HIGHLIGHT.g, Grichelde.COLORS.HIGHLIGHT.b, Grichelde.COLORS.HIGHLIGHT.a
-        )
-
-        tooltip:AddDoubleLine(self.L.Options_Minimap_Tooltip_Options_Left, self.L.Options_Minimap_Tooltip_Options_Right,
-            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
-            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
-        )
-        tooltip:AddDoubleLine(self.L.Options_Minimap_Tooltip_Mappings_Left, self.L.Options_Minimap_Tooltip_Mappings_Right,
-            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
-            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
-        )
-    end
-
-    local ldb = LibStub("LibDataBroker-1.1"):NewDataObject(self.name, {
-        type = "launcher",
-        text = self.AddonName,
-        icon = "Interface\\Icons\\Spell_Holy_Silence",
-        --icon = ([[Interface\Addons\%s\%s]]):format(self.name, self.name),
-        OnClick = toggleOptionsUI,
-        OnRightClick = function() self:ShowMappings() end,
-        OnTooltipShow = tooltip,
-    })
-
-    local icon = LibStub("LibDBIcon-1.0")
-    self:DebugPrint("MinimapButton : hidden: ", self.db.profile.minimapButton.hide)
-    icon:Register(self.name, ldb, self.db.profile.minimapButton)
-
-    return ldb, icon
-end
-
-
 function Grichelde:ToggleOptions()
-    self:DebugPrint("MinimapButton : options open: ", self.dialog.OpenFrames[self.name])
+    self:DebugPrint("ToggleOptions : options open: ", not not self.dialog.OpenFrames[self.name])
-    if self.dialog.OpenFrames[self.name] then
+    if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
         self:CloseOptions()
     else
         self:OpenOptions()
@@ -317,44 +474,153 @@ function Grichelde:ToggleOptions()
 end
 
 function Grichelde:OpenOptions()
-    self.dialog:Open(self.name)
+    if (self.dialog ~= nil) then
+        self.dialog:Open(self.name)
+
+        local formatString = self.L.AddonLoaded
+        if (self.db.profile.enabled == false) then
+            formatString = self.L.AddonUnloaded
+        end
+
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        local statusText = self:Format(formatString, namePlusVersion)
+        self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
+    end
 end
 
 function Grichelde:CloseOptions()
-    self.dialog:Close(self.name)
+    if (self.dialog ~= nil) then
+        self.dialog:Close(self.name)
+    end
 end
 
+--- If all replacements were disabled
+-- @return (boolean)
 function Grichelde:IsDisabled(info)
-    if info.option.type == "group" then
+    if (info and (info.option.type == "group")) then
         return false
     end
     return not self.db.profile.enabled
 end
 
+--- If all replacements were disabled
+-- @return (boolean)
+function Grichelde:IsMappingActive(info)
+    self:TracePrint("IsMappingActive : info")
+    for i = 0, #info do
+        self:TracePrint("IsMappingActive : info[%d] = %s", i, info[i])
+    end
+
+    if (info and (info.option.type == "group")) then
+        return true
+    end
+    if (self.db.profile.enabled == false) then
+        return false
+    end
+
+    local replacements = self.db.profile.replacements or {}
+    local currentName = info[2]
+    local uiElem = info[3]
+
+    self:DebugPrint("IsMappingActive : \"%s\"", currentName)
+    self:DebugPrint(replacements[currentName])
+
+    if (tContains({"moveUp", "moveDown", "matchWhen", "delete"}, uiElem)) then
+        return true
+    else
+        return replacements[currentName].matchWhen > 1
+    end
+end
+
 function Grichelde:MappingName(info)
 --  self:TracePrint("MappingName : info")
 --  self:TracePrint(info)
     local option = self.db.profile.replacements[info[2]]
 
-    if nilOrEmpty(option.searchText) and nilOrEmpty(option.replaceText) then
+    if (nilOrEmpty(option.searchText) and nilOrEmpty(option.replaceText)) then
-        return self.L.Options_Mapping_EmptyMapping
+        return cGray(self.L.Options_Mapping_EmptyMapping)
     else
-        return self:Format(self.L.Options_Mapping_Group_Name, option.searchText or "", option.replaceText or "")
+        local name = self:Format(self.L.Options_Mapping_Group_Name, option.searchText or "", option.replaceText or "")
+        if (option.matchWhen > 1) then
+            return name
+        else
+            return cGray(name)
+        end
     end
 end
 
+function Grichelde:ExtractExampleNames()
+    local exampleNames = {}
+    for _, example in ipairs(self.L.Options_Help_Examples) do
+        tInsert(exampleNames, example.name)
+    end
+    return exampleNames
+end
 
---- Create UI options for rhe given replacement table (from DB).
+function Grichelde:ExtractExampleCodes(num)
+    self:TracePrint("ExtractExampleCodes : number is: %d", num)
+    if (self.L.Options_Help_Examples[num] == nil) or (#self.L.Options_Help_Examples < num) then
+        self:DebugPrint("ExtractExampleCodes : invalid number: %d", num)
+        return self.L.Options_Help_Examples_Text
+    end
+
+    local exampleCodes = ""
+    for replName, replTable in spairs(self.L.Options_Help_Examples[num].replacements) do
+        self:TracePrint("ExtractExampleCodes : replacement: %s", replName)
+        self:TracePrint(replTable)
+
+        if (replTable ~= nil) and (replTable.searchText ~= nil) then
+            if (exampleCodes ~= "") then
+                exampleCodes = exampleCodes .. "|n|n"
+            end
+            exampleCodes = exampleCodes .. cPrefix(format("%s => %s", replTable.searchText, replTable.replaceText))
+        end
+    end
+    return exampleCodes
+end
+
+function Grichelde:ImportExample(num)
+    self:TracePrint("ImportExample : number is: %d", num)
+    if (self.L.Options_Help_Examples[num] == nil) or (#self.L.Options_Help_Examples < num) then
+        self:DebugPrint("ImportExample : invalid number: %d", num)
+    end
+
+    local profileName = self.L.Options_Help_Examples[num].name
+    self:DebugPrint("ImportExample : profile name: %s", profileName)
+    local allProfiles = self.db:GetProfiles()
+
+    if (not tContains(allProfiles, profileName)) then
+        -- create new profile if not exists
+        self.db:SetProfile(profileName)
+        assert(self.db:GetCurrentProfile() == profileName, "profile was not loaded")
+
+        tWipe(self.db.profile.replacements)
+        for replName, replTable in spairs(self.L.Options_Help_Examples[num].replacements) do
+            self:TracePrint("ImportExample : replacement: %s", replName)
+            self:TracePrint(replTable)
+
+            if (replName ~= nil) and (replTable ~= nil) and (replTable.searchText ~= nil) then
+                self.db.profile.replacements[replName] = tClone(replTable)
+            end
+        end
+
+        self:RefreshProfiles("ImportExample" .. num)
+    else
+        self:ErrorPrint(self.L.Profiles_AlreadyExistsError, profileName)
+    end
+end
+
+--- Create UI options for the given replacement table (from DB).
 --- Usually called with with self.db.profile.replacements
 -- @param replacementsTable
-function Grichelde:RefreshReplacements(replacementsTable)
+function Grichelde:RefreshOptions(replacementsTable)
-    self:TracePrint("RefreshReplacements : DB table:")
+    self:TracePrint("RefreshOptions : DB table:")
     self:TracePrint(replacementsTable)
 
     -- remove all previous replacements from options (not DB), except header and buttons
     local replacements = self.options.args.replacements.args or {}
     for k, _ in pairs(replacements) do
-        if k and find(k, "^replacement_") then
+        if (k and (find(k, "^replacement_") ~= nil)) then
             replacements[k] = nil
         end
     end
@@ -364,9 +630,11 @@ function Grichelde:RefreshReplacements(replacementsTable)
         replacements[replName] = self:CreateMapping(toNumber(replNumber))
     end
 
---  self:TracePrint("RefreshReplacements : UI options:")
+--  self:TracePrint("RefreshOptions : UI options:")
 --  self:TracePrint(replacements)
+end
 
+function Grichelde:RefreshDialog()
     self.dialog:ConfigTableChanged(nil, self.name)
 end
 
@@ -376,10 +644,10 @@ function Grichelde:AddEmptyMapping()
     self:DebugPrint("AddEmptyMapping : old DB entries:")
     self:DebugPrint(replacements)
 
-    local maxRepl = Grichelde.MAPPING_OFFSET
+    local maxRepl = Grichelde.MAPPING_OFFSET - 1
     for replName, _ in pairs(replacements) do
         local num = match(replName, "^replacement_(%d+)")
-        if num and maxRepl < toNumber(num) then
+        if (num ~= nil) and (maxRepl < toNumber(num)) then
             maxRepl = toNumber(num)
         end
     end
@@ -392,7 +660,7 @@ function Grichelde:AddEmptyMapping()
     self:DebugPrint("AddEmptyMapping : new DB entries:")
     self:DebugPrint(replacements)
 
-    self:RefreshOptions("AddEmptyMapping " .. newMapping)
+    self:RefreshProfiles("AddEmptyMapping " .. newMapping)
     self.dialog:SelectGroup(self.name, "replacements", newMapping)
 end
 
@@ -412,7 +680,7 @@ function Grichelde:MoveUp(info)
     local currentOrder = toNumber(replNumber)
 
     -- if not on top
-    if currentOrder ~= Grichelde.MAPPING_OFFSET then
+    if (currentOrder ~= Grichelde.MAPPING_OFFSET) then
         local swapName = "replacement_" .. toString(currentOrder - 1)
 
         -- swap ordering
@@ -421,7 +689,7 @@ function Grichelde:MoveUp(info)
         replacements[swapName].order = currentOrder
         replacements[currentName].order = currentOrder - 1
 
-        self:RefreshOptions("MoveUp " .. currentName)
+        self:RefreshProfiles("MoveUp " .. currentName)
 
         self:DebugPrint("MoveUp : refresh focus on %s", swapName)
         self.dialog:SelectGroup(self.name, "replacements", swapName)
@@ -455,7 +723,7 @@ function Grichelde:MoveDown(info)
 
     -- if not last element
     self:DebugPrint("MoveDown : maxRepl: %d", maxRepl)
-    if currentOrder < maxRepl then
+    if (currentOrder < maxRepl) then
         local swapName = "replacement_" .. toString(currentOrder + 1)
 
         -- swap ordering
@@ -464,7 +732,7 @@ function Grichelde:MoveDown(info)
         replacements[swapName].order = currentOrder
         replacements[currentName].order = currentOrder + 1
 
-        self:RefreshOptions("MoveDown " .. currentName)
+        self:RefreshProfiles("MoveDown " .. currentName)
 
         self:DebugPrint("MoveDown : refresh focus on %s", swapName)
         self.dialog:SelectGroup(self.name, "replacements", swapName)
@@ -473,6 +741,66 @@ function Grichelde:MoveDown(info)
     end
 end
 
+function Grichelde:GetMoveUpImage(info)
+    self:TracePrint("GetMoveUpImage : info")
+    for i = 0, #info do
+        self:TracePrint("%d = %s", i, info[i])
+    end
+
+    local currentName = info[2]
+    self:DebugPrint("GetMoveUpImage : \"%s\"", currentName)
+
+    local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
+    local currentOrder = toNumber(replNumber)
+
+    if (self:IsMappingActive(info) and (currentOrder > Grichelde.MAPPING_OFFSET)) then
+        return Grichelde.ICONS.MOVE_UP
+    else
+        return Grichelde.ICONS.MOVE_UP_DISABLED
+    end
+end
+
+function Grichelde:GetMoveDownImage(info)
+    self:TracePrint("GetMoveDownImage : info")
+    for i = 0, #info do
+        self:TracePrint("%d = %s", i, info[i])
+    end
+
+    local currentName = info[2]
+    self:DebugPrint("GetMoveDownImage : \"%s\"", currentName)
+
+    local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
+    local currentOrder = toNumber(replNumber)
+
+    local maxRepl = Grichelde.MAPPING_OFFSET
+    local replacements = self.db.profile.replacements or {}
+    for replName, _ in pairs(replacements) do
+        local num = match(replName, "^replacement_(%d+)")
+        if (num ~= nil) and (maxRepl < toNumber(num)) then
+            maxRepl = toNumber(num)
+        end
+    end
+
+    if (self:IsMappingActive(info) and (currentOrder < maxRepl)) then
+        return Grichelde.ICONS.MOVE_DOWN
+    else
+        return Grichelde.ICONS.MOVE_DOWN_DISABLED
+    end
+end
+
+function Grichelde:GetDeleteImage(info)
+    self:TracePrint("GetDeleteImage : info")
+    for i = 0, #info do
+        self:TracePrint("%d = %s", i, info[i])
+    end
+
+    if (self:IsMappingActive(info)) then
+        return Grichelde.ICONS.DELETE
+    else
+        return Grichelde.ICONS.DELETE_DISABLED
+    end
+end
+
 function Grichelde:DeleteMapping(info)
     self:TracePrint("DeleteMapping : info")
     for i = 0, #info do
@@ -484,7 +812,7 @@ function Grichelde:DeleteMapping(info)
     self:DebugPrint("delete option: %s", currentName)
     self.db.profile.replacements[currentName] = nil
 
-    self:RefreshOptions("DeleteMapping " .. currentName)
+    self:RefreshProfiles("DeleteMapping " .. currentName)
 
     local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
     local newMapping = "replacement_" .. toNumber(replNumber - 1)
@@ -495,28 +823,8 @@ function Grichelde:DeleteAllMappings()
     self:DebugPrint("DeleteAllMappings")
 
     -- do NOT set self.db.profile.replacements = {} it will break defaults
-    for replName, _ in pairs(self.db.profile.replacements or {}) do
+    tWipe(self.db.profile.replacements)
-        self.db.profile.replacements[replName] = nil
-    end
     self:AddEmptyMapping()
 
-    self:RefreshOptions("DeleteAllMappings")
+    self:RefreshProfiles("DeleteAllMappings")
 end
-
-function Grichelde:ToogleMinimapButton(info, val)
-    self:TracePrint("ToogleMinimapButton : info")
-    for i = 0, #info do
-        self:TracePrint("%d = %s", i, info[i])
-    end
-
-    self.db.profile.minimapButton.hide = not val
-    self:DebugPrint("ToogleMinimapButton : hidden: ", self.db.profile.minimapButton.hide)
-
-    if self.db.profile.minimapButton.hide then
-        self.icon:Hide(self.name);
-    else
-        self.icon:Show(self.name);
-    end
-end
-
-

GricheldeTest.lua

@@ -0,0 +1,786 @@
+-- import addon read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local find, pairs, tSize, cRed, cGreen, format = Grichelde.F.find, Grichelde.F.pairs, Grichelde.F.tSize, Grichelde.F.cRed, Grichelde.F.cGreen, Grichelde.F.format
+
+function Grichelde:TestMatch(text, pattern)
+    -- disable debug print out for testing
+    local oldLogLevel = Grichelde.logLevel
+    Grichelde.logLevel = 0
+
+    local pos1, pos2, cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9 = find(text, pattern)
+    self:PrefixedPrint("TestMatch : text: %s, pattern: %s, pos1: %d, pos2: %d", text, pattern, pos1, pos2)
+    self:PrefixedPrint("TestMatch : cap1: %s, cap2: %s, cap3: %s, cap4: %s, cap5: %s, cap6: %s, cap7: %s, cap8: %s, cap9: %s", cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9)
+
+    -- restore old loglevel
+    Grichelde.logLevel = oldLogLevel
+end
+
+function Grichelde:RunTests()
+    local function test(name, replacements, testData, replaceEmotes)
+        local i, ok, size = 0, 0, tSize(testData)
+        for input, expected in pairs(testData) do
+            local actual = self:ReplaceText(input, replacements, replaceEmotes or false)
+            i = i + 1
+            if (actual == expected) then
+                ok = ok + 1
+                self:PrefixedPrint("Test \"%s\" (%d/%d) %s: \"%s\" => \"%s\"", name, i, size, cGreen("passed"), input, expected)
+            else
+                self:PrefixedPrint("Test \"%s\" (%d/%d) %s: \"%s\" => \"%s\", but was \"%s\"", name, i, size, cRed("failed"), input, expected, actual)
+            end
+        end
+        return ok, size
+    end
+
+    -- disable debug print out for testing
+    local oldLogLevel = Grichelde.logLevel
+    Grichelde.logLevel = 0
+
+    local ok, all, o, a = 0, 0, 0, 0
+
+    -- basic tests
+    o, a = test(
+        "fehlender Unterkiefer",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["abc"] = "abc",
+            ["soo"] = "choo",
+            ["oos"] = "ooch",
+            ["oso"] = "ocho",
+            ["sos"] = "choch",
+            ["ssoo"] = "choo",
+            ["osso"] = "ocho",
+            ["ooss"] = "ooch",
+            ["ABC"] = "ABC",
+            ["Soo"] = "Choo",
+            ["ooS"] = "ooCH",
+            ["oSo"] = "oCho",
+            ["SOS"] = "CHOCH",
+            ["SSoo"] = "CHoo",
+            ["OSSO"] = "OCHO",
+            ["ooSS"] = "ooCH",
+            ["schmeissen"] = "chmeichen",
+            ["Schön"] = "Chön",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- case sensivity and extended replacements
+    o, a = test(
+        "Zark",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "Zark",
+                replaceText = "Schami",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Zark"] = "Schami",
+            ["ZARK"] = "SCHAMI",
+            ["Zarkilein"] = "Schamiilein",
+            ["ZARKILEIN"] = "SCHAMIILEIN",
+            ["Zark!"] = "Schami!",
+            ["ZARK!"] = "SCHAMI!",
+            ["Zark ist tot"] = "Schami ist tot",
+            ["ZARK ist tot"] = "SCHAMI ist tot",
+            ["Zark ist der Tod"] = "Schami ist der Tod",
+            ["ZARK IST DER TOD"] = "SCHAMI IST DER TOD",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- start/end of sentence/words
+    o, a = test(
+        "wann",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "bcd",
+                replaceText = "efg",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "uio",
+                replaceText = "bnm",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "hij",
+                replaceText = "klm",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "nop",
+                replaceText = "qrs",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "tuv",
+                replaceText = "wxy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 6,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "wer",
+                replaceText = "sdf",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 7,
+                stopOnMatch = false,
+            },
+        },
+        {
+            -- replacement_10
+            ["bcd"] = "efg",
+            ["abcdz"] = "aefgz",
+            ["abcd"] = "aefg",
+            ["bcdz"] = "efgz",
+            -- replacement_11
+            ["uio"] = "bnm",
+            ["auioz"] = "auioz",
+            ["auio"] = "auio",
+            ["uioz"] = "uioz",
+            -- replacement_12
+            ["hij"] = "klm",
+            ["ahijz"] = "ahijz",
+            ["ahij"] = "ahij",
+            ["hijz"] = "klmz",
+            -- replacement_13
+            ["nop"] = "qrs",
+            ["anopz"] = "anopz",
+            ["anop"] = "aqrs",
+            ["nopz"] = "nopz",
+            -- replacement_14
+            ["tuv"] = "wxy",
+            ["atuvz"] = "atuvz",
+            ["atuv"] = "awxy",
+            ["tuvz"] = "wxyz",
+            -- replacement_15
+            ["wer"] = "wer",
+            ["awerz"] = "asdfz",
+            ["awer"] = "awer",
+            ["werz"] = "werz",
+
+            -- replacement_10
+            ["bcd abcdz abcd bcdz"] = "efg aefgz aefg efgz",
+            -- replacement_11
+            ["uio auioz auio uioz"] = "bnm auioz auio uioz",
+            -- replacement_12
+            ["hij ahijz ahij hijz"] = "klm ahijz ahij klmz",
+            -- replacement_13
+            ["nop anopz anop nopz"] = "qrs anopz aqrs nopz",
+            -- replacement_14
+            ["tuv atuvz atuv tuvz"] = "wxy atuvz awxy wxyz",
+            -- replacement_15
+            ["wer awerz awer werz"] = "wer asdfz awer werz",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "consolidate",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "a",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "b",
+                replaceText = "c",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "d",
+                replaceText = "e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["aaa"] = "c",
+            ["abb"] = "c",
+            ["abc"] = "c",
+            ["bbc"] = "c",
+            ["ace"] = "ce",
+            ["abe"] = "ce",
+            ["bbe"] = "ce",
+            ["ece"] = "ece",
+            ["ede"] = "ee",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- stop on match
+    o, a = test(
+        "stopOnMatch",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "a",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = true,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "b",
+                replaceText = "c",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "c",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = true,
+            },
+        },
+        {
+            ["aaa"] = "bbb",
+            ["abc"] = "bbc",
+            ["bbc"] = "ddd",
+            ["bca"] = "bcb",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Jar Jar Binks (DE)",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "ver",
+                replaceText = "va",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "en",
+                replaceText = "'n",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "(%w?)ich",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "(d?m?)ir",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "du",
+                replaceText = "du da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "erse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "sie",
+                replaceText = "sie da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "wir",
+                replaceText = "wirse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "ihr",
+                replaceText = "ihrse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "nicht",
+                replaceText = "nich",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "die",
+                replaceText = "de",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Ich kann dich verstehen."] = "Ichse kann dichse vasteh'n.",
+            ["Wir haben sie die ganze Zeit über nicht verstanden"] = "Wirse hab'n sie da de ganze Zeit üba nich vastand'n",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Stottern 1",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^bwp%s]-)([bwp])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Ich mag dich."] = "I-I-Ich mag dich.",
+            ["Dich mag ich."] = "Di-Di-Dich mag ich.",
+            ["Bmm rrpss w"] = "B-B-Bmm rrp-rrp-rrpss w-w-w",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "trollifier",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, mon%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "what are you",
+                replaceText = "whatcha",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "your?s?",
+                replaceText = "ya",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "going to",
+                replaceText = "gonna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "want to",
+                replaceText = "wanna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["What are you going to do when they come for you?"] = "Whatcha gonna do when dey come for ya, mon?",
+            ["That's what young people are doing"] = "Dat's what young people are doin', mon",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Jar Jar Binks (EN)",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "me",
+                replaceText = "mesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "I am",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "I'm",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "I",
+                replaceText = "Me",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "you are",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "you're",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "your",
+                replaceText = "yous",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "(s?)he is",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "(s?)he's",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "they",
+                replaceText = "daysa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "them",
+                replaceText = "them-sa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_22 = {
+                order = 22,
+                searchText = "the",
+                replaceText = "da",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_23 = {
+                order = 23,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_24 = {
+                order = 24,
+                searchText = "yes",
+                replaceText = "yesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_25 = {
+                order = 25,
+                searchText = "oka?y?",
+                replaceText = "okeeday",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["I hear your voice through the thrilling grapewine."] = "Me hear yous voice drough da drillin' grapewine.",
+            ["They gave them their OK"] = "Daysa gave dem-sa deir OKEEDAY",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "old-fashioned",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "oi",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^aeiou]*)([aeiou])",
+                replaceText = "%1%2e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "yours",
+                replaceText = "thy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "youe",
+                replaceText = "thou",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Do you want to kill yours?"] = "Doe thou want toe kill thy?",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "emote detection on",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "r",
+                replaceText = "rr",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Der Herr Richter *schaut Herrn Richter an*"] = "Derr Herrrr Rrichterr *schaut Herrn Richter an*",
+            ["*schaut Herrn Richter an*"] = "*schaut Herrn Richter an*",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "emote detection ignored",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "r",
+                replaceText = "rr",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Der Herr Richter *schaut Herrn Richter an*"] = "Derr Herrrr Rrichterr *schaut Herrrrn Rrichterr an*",
+            ["*schaut Herrn Richter an*"] = "*schaut Herrrrn Rrichterr an*",
+        },
+        true
+    )
+    ok = ok + o
+    all = all + a
+
+    if (ok == all) then
+        self:PrefixedPrint("All %d tests %s", all, cGreen("passed"))
+    else
+        self:PrefixedPrint("%d test %s, %d tests %s", all - ok, cRed("failed"), ok, cGreen("passed"))
+    end
+
+    -- restore old loglevel
+    Grichelde.logLevel = oldLogLevel
+end

GricheldeUpgrade.lua

@@ -1,11 +1,12 @@
 -- read namespace from global env
 local _G = _G
-local Grichelde = _G.Grichelde
+local Grichelde = _G.Grichelde or {}
 
-local pairs, find, toNumber = Grichelde.functions.pairs, Grichelde.functions.find, Grichelde.functions.toNumber
+local pairs, tSize, tClone, find, sub, cGreen, cOrange, cRed, toNumber
+    = Grichelde.F.pairs, Grichelde.F.tSize,Grichelde.F.tClone, Grichelde.F.find, Grichelde.F.sub, Grichelde.F.cGreen, Grichelde.F.cOrange, Grichelde.F.cRed, Grichelde.F.toNumber
 
 function Grichelde:Upgrade_To_v060()
-    self:PrefixedPrint(self.L.Upgrade_ToVersion, Grichelde.COLOR_CODES.ORANGE .. "0.6.0" .. Grichelde.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.6.0"))
 
     local replacements = self.db.profile.replacements or {}
     self:DebugPrint("Upgrade_To_v060 : old database")
@@ -22,10 +23,10 @@ function Grichelde:Upgrade_To_v060()
 end
 
 function Grichelde:Upgrade_To_v070()
-    self:PrefixedPrint(self.L.Upgrade_ToVersion, Grichelde.COLOR_CODES.ORANGE .. "0.7.0" .. Grichelde.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.7.0"))
 
     local replacements = self.db.profile.replacements or {}
-    self:DebugPrint("Upgrade_To_v070 : old database")
+    self:DebugPrint("Upgrade_To_v070 : old replacements")
     self:DebugPrint(replacements)
 
     for _, replTable in pairs(replacements) do
@@ -33,13 +34,13 @@ function Grichelde:Upgrade_To_v070()
         replTable["ignoreCase"] = nil
     end
 
-    self:DebugPrint("Upgrade_To_v070 : new database")
+    self:DebugPrint("Upgrade_To_v070 : new replacements")
     self:DebugPrint(replacements)
     return 0, 7, 0
 end
 
 function Grichelde:Upgrade_To_v072()
-    self:PrefixedPrint(self.L.Upgrade_ToVersion, Grichelde.COLOR_CODES.ORANGE .. "0.7.2" .. Grichelde.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.7.2"))
 
     self:DebugPrint("Upgrade_To_v072 : old database")
     self:DebugPrint(self.db.profile)
@@ -51,39 +52,134 @@ function Grichelde:Upgrade_To_v072()
     return 0, 7, 2
 end
 
+function Grichelde:Upgrade_To_v080()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.8.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v080 : old replacements")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        replTable["active"] = true
+    end
+
+    self:DebugPrint("Upgrade_To_v080 : new replacements")
+    self:DebugPrint(self.db.profile)
+    return 0, 8, 0
+end
+
+function Grichelde:Upgrade_To_v090()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.9.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v090 : old replacements")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        if (replTable["active"] == true) then
+            replTable["matchWhen"] = 2
+        else
+            replTable["matchWhen"] = 1
+        end
+        replTable["active"] = nil
+    end
+
+    self:DebugPrint("Upgrade_To_v090 : new replacements")
+    self:DebugPrint(self.db.profile)
+    return 0, 9, 0
+end
+
 function Grichelde:UpgradeDatabase()
-    local dbVersion = self.db.global.version or "0.0.0"
+    local function parseVersion(version)
-    self:DebugPrint("Database version:", dbVersion)
+        local _, _, major, minor, patch, ext = find(version, "(%d+)%.(%d+)%.(%d+)(.*)")
-
+        local preBuild, build = ext, ""
-    local _, _, maj, min, pat = find(dbVersion, "(%d+)%.(%d+)%.(%d+).*")
+        if (sub(ext, 1, 1) == "-") then
-    local major, minor, patch = toNumber(maj) or 0, toNumber(min) or 0, toNumber(pat) or 0
+            local b = find(ext, "+", 2)
-
+            if (b ~= nil) then
-    local upgrade = 0
+                preBuild = sub(ext, 1, b)
-    local error = false
+                build = sub(ext, b + 1)
-
+            else
-    if major == 0 then
+                preBuild = sub(ext, 1, b)
-        if minor < 6 then
+            end
-            upgrade = upgrade + 1
-            major, minor, patch = self:Upgrade_To_v060(dbVersion)
         end
-        if minor < 7 then
+        return toNumber(major) or 0, toNumber(minor) or 0, toNumber(patch) or 0, preBuild, build
-            upgrade = upgrade + 1
+    end
-            major, minor, patch = self:Upgrade_To_v070(dbVersion)
+
+    local gMajor, gMinor, gPatch = parseVersion(self.version)
+    local dbVersion = self.db.global.version
+
+    if (dbVersion == nil) then
+        self:DebugPrint("New installation detected, add sample mappings")
+        -- do NOT set self.db.profile.replacements = {} it will break defaults
+        local sampleRepl = self.getDefaultSampleMappings()
+        for replName, replTable in pairs(sampleRepl) do
+            self:TracePrint("UpgradeDatabase : copySampleMappings %s", replName)
+            self.db.profile.replacements[replName] = tClone(replTable)
         end
-        if minor == 7 then
+
-            if patch < 2 then
+        self.db.global.version = self:Format("%d.%d.%d", gMajor, gMinor, gPatch)
-                upgrade = upgrade + 1
+        self:DebugPrint("Database version %s sucessfully created", self.db.global.version)
-                major, minor, patch = self:Upgrade_To_v072(dbVersion)
+    else
+        -- detect if upgrade is neccessary or downgrade was done
+        self:DebugPrint("Detected database version:", dbVersion)
+
+        local dbMajor, dbMinor, dbPatch = parseVersion(dbVersion)
+        local downGrade = false
+        if (dbMajor > gMajor) then
+            downGrade = true
+        elseif dbMajor == gMajor then
+            if (dbMinor > gMinor) then
+                downGrade = true
+            elseif dbMinor == gMinor then
+                if (dbPatch > gPatch) then
+                    downGrade = true
+                end
+            end
+        end
+
+        if downGrade then
+            self:PrefixedPrint(cRed(self.L.Downgrade_Detected), self.L.AddonName)
+        else
+            local upgrade = 0
+            local error = false
+
+            if (dbMajor == 0) then
+                if (dbMinor < 6) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v060(dbVersion)
+                end
+                if (dbMinor < 7) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v070(dbVersion)
+                end
+                if (dbMinor == 7) then
+                    if (dbPatch < 2) then
+                        upgrade = upgrade + 1
+                        dbMajor, dbMinor, dbPatch = self:Upgrade_To_v072(dbVersion)
+                    end
+                end
+                if (dbMinor < 8) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v080(dbVersion)
+                end
+                if (dbMinor < 9) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v090(dbVersion)
+                end
+            end
+
+            if (upgrade == 0) or (error == false) then
+                -- bump version number even if no update is required
+                self.db.global.version = self:Format("%d.%d.%d", gMajor, gMinor, gPatch)
+            end
+
+            if (upgrade == 0) then
+                self:DebugPrint("Database was up-to-date")
+            elseif (error == false) then
+                self:PrefixedPrint(cGreen(self.L.Upgrade_Successful))
+            else
+                self:PrefixedPrint(cRed(self.L.Upgrade_Error))
             end
         end
     end
-
-    if upgrade == 0 then
-        self:DebugPrint("Database up-to-date")
-    else
-        if not error then
-            self.db.global.version = self.version
-            self:PrefixedPrint(Grichelde.COLOR_CODES.GREEN .. self.L.Upgrade_Successful .. Grichelde.COLOR_CODES.CLOSE)
-        end
-    end
 end

GricheldeUtils.lua

@@ -1,18 +1,18 @@
 -- import addon read namespace from global env
 local _G = _G
-local Grichelde = _G.Grichelde
+local Grichelde = _G.Grichelde or {}
 
-local type, print, pairs, tSize, select, unpack, find, format, rep, toString
+local type, print, pairs, tSize, select, unpack, find, cGray, cDarkgray, cRed, cPrefix, format, rep, toString
-    = Grichelde.functions.type, Grichelde.functions.print, Grichelde.functions.pairs, Grichelde.functions.tSize, Grichelde.functions.select, Grichelde.functions.unpack, Grichelde.functions.find, Grichelde.functions.format, Grichelde.functions.rep, Grichelde.functions.toString
+    = Grichelde.F.type, Grichelde.F.print, Grichelde.F.pairs, Grichelde.F.tSize, Grichelde.F.select, Grichelde.F.unpack, Grichelde.F.find, Grichelde.F.cGray, Grichelde.F.cDarkgray, Grichelde.F.cRed, Grichelde.F.cPrefix, Grichelde.F.format, Grichelde.F.rep, Grichelde.F.toString
 
 -- show strings differently to distinguish them from numbers
-local function plainValue(val)
+function Grichelde:plainValue(val)
-    if val == nil then
+    if (val == nil) then
         return "<nil>"
-    elseif type(val) == "string" then
+    elseif (type(val) == "string") then
         return '"' .. val .. '"'
-    elseif type(val) == "table" then
+    elseif (type(val) == "table") then
-        if tSize(val) > 0 then
+        if (tSize(val) > 0) then
             return toString(val)
         else
             return "{}"
@@ -23,33 +23,36 @@ local function plainValue(val)
 end
 
 --- Prints any value to default channel, do NOT return a string.
-local function tPrint(val, indent, known, printFunc)
+function Grichelde:tPrint(val, indent, known, printFunc)
     local printF = printFunc or print
     indent = indent or 0
     known = known or {}
 
-    if val == nil then
+    if (val == nil) then
         printF(rep(" ", indent) .. "<nil>")
-    elseif type(val) == "string" then
+    elseif (type(val) == "string") then
         printF(rep(" ", indent) .. "\"" .. val .. "\"")
-    elseif type(val) == "table" then
+    elseif (type(val) == "table") then
-        if tSize(val) > 0 then
+        if (tSize(val) > 0) then
             for key, value in pairs(val) do
-                if value == nil then
+                if (value == nil) then
-                    printF(rep(" ", indent) .. plainValue(key) .. " = <nil>")
+                    printF(rep(" ", indent) .. self:plainValue(key) .. " = <nil>")
-                elseif type(value) == "table" then
+                elseif (type(value) == "table") then
-                    printF(rep(" ", indent) .. plainValue(key) .. " = {")
+                    printF(rep(" ", indent) .. self:plainValue(key) .. " = {")
-                    if tSize(value) > 0 then
+                    if (tSize(value) > 0) then
                         if not known[value] then
-                            tPrint(value, indent + 4, known, printF)
+                            self:tPrint(value, indent + 4, known, printF)
                             known[value] = true
                         else
-                            printF("<known table> " .. plainValue(value))
+                            printF("<known table> " .. self:plainValue(value))
                         end
                     end
                     printF(rep(" ", indent) .. "}")
                 else
-                    printF(rep(" ", indent) .. plainValue(key) .. " = " .. plainValue(value))
+                    local k = self:plainValue(key)
+                    local v = self:plainValue(value)
+                    --print( "k: " .. k .. ", v: " ..v)
+                    printF(rep(" ", indent) .. k .. " = " .. v)
                 end
             end
         else
@@ -60,9 +63,9 @@ local function tPrint(val, indent, known, printFunc)
     end
 end
 
--- split at first word of a text line
+--- Splits at first word of a text line
 function Grichelde:SplitOnFirstMatch(text, delimPattern, start)
-    if text == nil then return nil end
+    if (text == nil) then return nil end
     local pattern = "^(.-)" .. (delimPattern or " " ) .."(.*)"
     local pos = start or 1
     self:TracePrint("SplitOnFirstMatch : text: %s, pattern: %s, start: %d", text, pattern, start)
@@ -71,7 +74,7 @@ function Grichelde:SplitOnFirstMatch(text, delimPattern, start)
     return left or text, right
 end
 
--- split at last word of a text line
+--- Splits at last word of a text line
 function Grichelde:SplitOnLastMatch(text, delimPattern, start)
     local pattern = "(.*)" .. (delimPattern or " ") .. "(.-)$"
     local pos = start or 1
@@ -81,118 +84,125 @@ function Grichelde:SplitOnLastMatch(text, delimPattern, start)
     return left, right or text
 end
 
--- split at last word of a text line
+--- Splits at last word of a text line
 function Grichelde:TestMatch(text, pattern)
-    local _, _, left, right = find(text, pattern, 1)
+    local pos1, pos2, left, right = find(text, pattern, 1)
-    self:DebugPrint("TestMatch : left: %s, right: %s", left, right)
+    self:DebugPrint("TestMatch : pos1: %d, pos2: %d, left: %s, right: %s", pos1, pos2, left, right)
 end
 
 function Grichelde:Format(message, ...)
-    if ( not message ) then
+    if (message == nil) then
         return "<nil>"
-    elseif type(message) == "string" then
+    elseif (type(message) == "string") then
-        if ( not find(message, "%%")) then
+        if (find(message, "%%") == nil) then
+            --print("message: ", message)
+            --print("...: ", ...)
             return message, ...
         else
             local l = select("#", ...)
-            if l > 0 then
+            if (l > 0) then
                 -- sanitize nil values in vararg
                 local packed = { ... }
                 for i = 1, l do
                     packed[i] = toString(packed[i]) or "nil"
+                    --print("packed[i] = ", packed[i])
+                    --packed[i] = gsub(packed[i], "%%(%d)", "%%%%%1")
                 end
 --              print("packed = ", packed)
 --              self:tPrint(packed)
                 -- cannot assign unpacked to a vararg variable and print it for debug
                 -- Manually set count as unpack() stops on nil (bug with #table)
                 return format(message, unpack(packed, 1, l))
+            else
+                return message
             end
         end
     end
 end
 
---- deprecated
+function Grichelde:PrefixedPrint(...)
-function Grichelde:Print(...)
+    print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
-    print(self:Format(...))
 end
 
-function Grichelde:PrefixedPrint(...)
+function Grichelde:ErrorPrint(...)
-    print(self.COLOR_CODES.PREFIX .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+    print(cPrefix(self.L.AddonName) .. ": " .. cRed(self:Format(...)))
 end
 
 function Grichelde:DebugPrint(obj, ...)
-    self:LogPrint(Grichelde.LOG_LEVEL.DEBUG, function(...)
+    if (self.logLevel >= Grichelde.LOG_LEVEL.DEBUG) then
-        print(self.COLOR_CODES.GRAY .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+        self:LogPrint(function(...)
-    end, obj, ...)
+            print(cGray(self.L.AddonName) .. ":", self:Format(...))
+        end, obj, ...)
+    end
 end
 
 function Grichelde:TracePrint(obj, ...)
-    self:LogPrint(Grichelde.LOG_LEVEL.TRACE, function(...)
+    if (self.logLevel >= Grichelde.LOG_LEVEL.TRACE) then
-        print(self.COLOR_CODES.DARKGRAY .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+        self:LogPrint(function(...)
-    end, obj, ...)
+            print(cDarkgray(self.L.AddonName) .. ":", self:Format(...))
+        end, obj, ...)
+    end
 end
 
-function Grichelde:LogPrint(logLevel, printFunc, obj, ...)
+function Grichelde:LogPrint(printFunc, obj, ...)
-    if (self.logLevel >= logLevel) then
+    local printF = printFunc or print
-        local printF = printFunc or print
+    if obj == nil then
-        if obj == nil then
+        printF("<nil>")
-            printF("<nil>")
+    else
-        else
+        if type(obj) == "string" then
-            if type(obj) == "string" then
+            local l = select("#", ...)
-                local l = select("#", ...)
+            if (l == 0) or (find(obj, "%%") == nil) then
-                if ( l == 0 or not find(obj, "%%")) then
+                printF(obj, ...)
-                    printF(obj, ...)
-                else
-                    -- sanitize nil values in vararg
-                    local packed = { ... }
-                    for i = 1, l do
-                        packed[i] = toString(packed[i]) or "nil"
-                    end
-
---                  print("packed = ", packed)
---                  self:tPrint(packed)
-                    -- cannot assign unpacked to a vararg variable and print it for debug
-                    local fmtMsg = format(obj, unpack(packed, 1, l)) -- manually set count as unpack() stops on nil (bug with #table)
-                    printF(fmtMsg)
-                end
-            elseif type(obj) == "table" then
-                tPrint(obj, 0, {}, printF)
             else
-                printF(plainValue(obj))
+                -- sanitize nil values in vararg
+                local packed = { ... }
+                for i = 1, l do
+                    packed[i] = toString(packed[i]) or "nil"
+                end
+
+--              print("packed = ", packed)
+--              self:tPrint(packed)
+                -- cannot assign unpacked to a vararg variable and print it for debug
+                local fmtMsg = format(obj, unpack(packed, 1, l)) -- manually set count as unpack() stops on nil (bug with #table)
+                printF(fmtMsg)
             end
+        elseif (type(obj) == "table") then
+            self:tPrint(obj, 0, {}, printF)
+        else
+            printF(self:plainValue(obj))
         end
     end
 end
 
 --- Print UI options to chat frame
 function Grichelde:PrintOptions()
-    self:PrefixedPrint(self.COLOR_CODES.PREFIX .. self.L.Debug_Options .. self.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(cPrefix(self.L.Debug_Options))
     self:LogPrint(-1, function(...)
-        print(self.COLOR_CODES.PREFIX .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
     end, self.options.args.replacements.args)
 end
 
---- Print DB
+--- Print current DB profile
 function Grichelde:PrintProfile()
-    self:PrefixedPrint(self.COLOR_CODES.PREFIX .. self.L.Debug_Profile .. self.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(cPrefix(self.L.Debug_Profile))
     self:LogPrint(-1, function(...)
-        print(self.COLOR_CODES.PREFIX .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
     end, self.db.profile)
 end
 
 --- Print DB replacements to chat frame
 function Grichelde:PrintMappings()
-    self:PrefixedPrint(self.COLOR_CODES.PREFIX .. self.L.Debug_Mappings .. self.COLOR_CODES.CLOSE)
+    self:PrefixedPrint(cPrefix(self.L.Debug_Mappings))
     self:LogPrint(-1, function(...)
-        print(self.COLOR_CODES.PREFIX .. self.L.AddonName .. self.COLOR_CODES.CLOSE .. ":", self:Format(...))
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
     end, self.db.profile.replacements)
 end
 
---- Open UI windows with replacements in it
+--- Open window with DB replacements in it
 function Grichelde:ToogleMappings()
     local AceGUI = LibStub("AceGUI-3.0")
 
-    if self.debugFrame then
+    if (self.debugFrame ~= nil) then
         AceGUI:Release(self.debugFrame)
         self.debugFrame = nil
     else
@@ -227,10 +237,10 @@ function Grichelde:ToogleMappings()
         local configBox = AceGUI:Create("MultiLineEditBox");
         configBox:SetLabel("")
         local text = ""
-        tPrint(replacements, 0, {}, function(s) text = text .. s .. "|n" end)
+        self:tPrint(replacements, 0, {}, function(s) text = text .. s .. "|n" end)
         configBox:SetText(text)
         configBox:SetFullWidth(true)
-        configBox:SetFullHeight(true)
+        --configBox:SetFullHeight(true)
         configBox:DisableButton(true)
         --configBox:SetDisabled(true)
         configBox:SetNumLines(50);

README.md

@@ -1,34 +1,74 @@
 # Grichelde - Text replacer
 
-Grichelde is a WoW Classic Addon that replaces characters you typed in a chatbox with any replacement text you specified in the addon options.   
+Grichelde is a WoW Classic Addon that replaces any characters or words you typed in a chat input line according to your replacement rules.
+The replacement is done **before** the text is send to other players/in the target channel. It does **not** change text other players have written in the chat, but the text they will see **from you**.
+
+Its purpose is to simulate a speaking disability of your toon and hereby strengthen immersion in roleplay. 
+Initially started as a helper addon for a roleplaying friend, Grichelde can be used for much more, like 
 
-Intentionally started as a helper addon for a roleplaying friend, Grichelde can be used for much more, like 
 * fixing your common spelling errors :)
 * replacing toon names with their nick names
 * write out abbreviations for you
 * create hilarious moments during roleplay
 
+However it does not replace slash commands with other slash commands, it only works for chat text. It you want to replace commands, 
+please look at more sophisticated chat addons like [Prat](https://www.curseforge.com/wow/addons/prat-3-0).  
+
+## Disclaimer
+#### No Warranty
+The addon is provided "AS IS" and comes without warranty of any kind of function or correctness (for more details, consult the GPL 3 license).
+Also the author is not held responsible for any risk or damage the addon or its use might cause, especially lost of progress or data due to crashes of the WoW client.
+
+#### Respect others
+This addon does not encourange or intend to hurt or to tease people with speaking disabilities or language disorders. 
+The responsibility rest on the user completely. Please use the features with care and respect to other players.
+                                 
 ## FAQ
 
-### How do I start
+#### Where do I start?
 
 Grichelde is active right from the start with default mappings. To open the options UI, either left-click on
 the new minimap icon, or type `/gri` or `/grichelde` in the chatbox. All mappings and channels can be configured there.
 
-### My replacement is not taken.
+#### Does it replace only letters but also whole words?
 
-After entering a search or replacement text, you see a button "Okay" next to yout input. This is **not** a validation message, 
+Grichelde is capable of handling both, even whole sentences can be replaced. 
-but the save button for text. This is a rectriction from the UI library and can be seen in other addons as well. 
+Only slash commands, item links, textures, placeholders and ooc-markers are excluded from replacement.
-Please click on "Okay" button to save the input permanently.
 
-### I get errors, what should I do?
+#### My replacement is not taken.
 
-Please report your errors here. Make a screenshot or copy both the error message as well as your recent mappings.
+After entering a search or replacement text, you see a button "Okay" next to your input. This is **not** a validation message, 
-You can bring up a small windows with your mapping by right-clicking the minimap icon or entering the "/gri mappings" command.
+but the save button for text. This is a restriction from the UI library and can be seen in other addons as well. 
+Please click on "Okay" to save the input permanently, otherwise it will not be stored..
 
-### Why that strange name?
+![click "Okay" on text changes](https://media.forgecdn.net/attachments/305/887/text-okay.jpg "change confirmation")
 
-Grichelde is the name of the undead rogue without a jaw, that was played in RP session with my friend.
+If it still does not work or gives you errors, please read the next question. 
-She started replacing "s" and "t" letters manually for each line in the chat, which is cumbersome over time.
+
-(If you wondered how an Undead without a jaw sounds like, its really hilarious.) Without spelling errors, 
+#### I have to disable the Addon frequently. Is there a more elegant solution?
-"Griselde" in German would be a old-fashioned female first name.
+
+Actually there are two solutions:
+1. A right-click on the minimap button will disable Grichelde instantly. Right-click a second time will activate it again. Easy, isn't it?
+2. You can disable Grichelde permanently and forcefully replace a sentence in the chatbox with manual override. I call it "Grichelde-On-Demand" :) 
+   In the chatbox put `/gri` or `/grichelde` in front of your typed text, you can also include the target channel, 
+   i.e. `/gri /guild hello there` and Grichelde will apply the active replacements and rules even if guild channel or Grichelde was disabled.
+
+#### I get errors, what should I do?
+
+Please report your errors on [project website](https://www.curseforge.com/wow/addons/grichelde) at curse forge. Make a screenshot or copy both the error message as well as your recent mappings.
+You can bring up a small windows with your mapping by entering the `/gri mappings` command on copy them.
+
+#### Why that strange name?
+
+Grichelde is the name of an Undead rogue without a jaw, who was played in RP sessions by a guild member.
+She started replacing `s` and `t` letters manually for each word in the chat, which became cumbersome over time.
+(If you ever wondered how an Undead without a jaw sounds like, its really hilarious, you should try it.) 
+Without spelling errors, "Griselde" in German is an old-fashioned female first name.
+
+#### I'm a Pro. Does it support regular expressions?
+
+RegEx are very powerful search and replacement patterns commonly used in programming. Technically all searches the addon performs on the input are done 
+with regular expression methods, however Lua unfortunately does not support full [PCRE](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) syntax and is very limited (read [here](http://www.lua.org/pil/20.1.html) why).
+Nevertheless some patterns can be used like the anchors start of line `^` or end of line `$`, capturing groups `(hello) (world)`, character classes like numbers `%d` or (inversed) sets `[^%p]`.
+
+Capture groups can be accessed in the replacement text with `%<number>` like in `%2 %1`. Also there are some mappings using RegEx in the Example section. 

libs.xml

@@ -2,16 +2,16 @@
 ..\FrameXML\UI.xsd">
 
   <Script file="Libs\LibStub\LibStub.lua"/>
-  <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua" />
-  <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua" />
   <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
   <Include file="Libs\AceAddon-3.0\AceAddon-3.0.xml"/>
-  <Include file="Libs\AceConfig-3.0\AceConfig-3.0.xml"/>
+  <Include file="Libs\AceLocale-3.0\AceLocale-3.0.xml" />
+  <Include file="Libs\AceEvent-3.0\AceEvent-3.0.xml" />
+  <Include file="Libs\AceHook-3.0\AceHook-3.0.xml"/>
   <Include file="Libs\AceConsole-3.0\AceConsole-3.0.xml"/>
   <Include file="Libs\AceDB-3.0\AceDB-3.0.xml"/>
   <Include file="Libs\AceDBOptions-3.0\AceDBOptions-3.0.xml"/>
-  <Include file="Libs\AceEvent-3.0\AceEvent-3.0.xml" />
   <Include file="Libs\AceGUI-3.0\AceGUI-3.0.xml"/>
-  <Include file="Libs\AceHook-3.0\AceHook-3.0.xml"/>
+  <Include file="Libs\AceConfig-3.0\AceConfig-3.0.xml"/>
-  <Include file="Libs\AceLocale-3.0\AceLocale-3.0.xml" />
+  <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua" />
+  <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua" />
 </Ui>

localisation/deDE.lua

@@ -1,28 +1,60 @@
-local L = LibStub('AceLocale-3.0'):NewLocale('Grichelde', 'deDE')
+-- read namespace from global env
+local AddonName, _ = ...
+local _G = _G
+local Grichelde = _G.Grichelde
+
+local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'deDE')
 if not L then return end
 
+local cYellow    = Grichelde.F.cYellow
+local cGray      = Grichelde.F.cGray
+local cHyperlink = Grichelde.F.cHyperlink
+local cPrefix    = Grichelde.F.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.VersionAbbr = "v"
+L.AddonNamePlusVersion = "%s v%s"
-L.AddonLoaded = "%s hilft Euch jetzt bei euren Sprachschwierigkeiten."
+L.AddonLoaded = "%s unterst\195\188tzt Euch jetzt bei euren Sprachschwierigkeiten."
+L.AddonUnloaded = "%s wartet geduldig Euch weiter unterst\195\188tzen zu d\195\188rfen."
 L.Upgrade_ToVersion = "Hebe Databank auf Version %s an."
 L.Upgrade_Successful = "Upgrade erfolgreich."
+L.Upgrade_Error = "Upgrade fehlgeschlagen!"
+L.Downgrade_Detected = "Downgrade erkannt, %s kann sich m\195\182glichweise fehlerhaft verhalten!"
+
+-- debug
 L.Debug_Options = "Optionen"
 L.Debug_Mappings = "Ersetzungen"
 L.Debug_Mappings_Hint = "Der Inhalt der Textbox dient nur zur Fehlersuche und kann herauskopiert werden. Es werden keine Werte aus dieser Textbox eingelesen oder anderweitig verwertet."
 L.Debug_Mappings_Found = "%d Ersetzungen gefunden"
 L.Debug_Profile = "Profil"
 
+-- errors
+L.Error_InvalidCommand = "Ung\195\188ltiger Befehl"
+L.Error_InvalidChannel = "Ung\195\188ltiger Kanal"
+L.Error_InvalidWhisperTarget = "Ung\195\188ltiger Fl\195\188sterziel"
+L.Error_UnsupportedChannel = "Nicht unterst\195\188tzter Kanal"
+
 -- profiles
 L.Profiles_Available = "Verf\195\188gbare Profile:"
 L.Profiles_Created = "Neues Profil %s angelegt."
 L.Profiles_Loaded = "Profil %s geladen."
+L.Profiles_Activated = "Profil %s aktiviert."
+L.Profiles_Deactivated = "Profil %s deaktiviert."
 L.Profiles_Refreshed = "Profil %s aktualisiert."
 L.Profiles_Deleted = "Profil %s gel\195\182scht."
 L.Profiles_Copied = "Einstellungen von Profil %s \195\188bernommen."
 L.Profiles_Reset = "Profil %s zur\195\188ckgesetzt."
 L.Profiles_Invalid = "Ung\195\188ltiges Profil %s!"
 L.Profiles_DeleteError = "Das aktive Profil kann nicht gel\195\182scht werden!"
+L.Profiles_AlreadyExistsError = "Das Profil %s existiert bereits!"
+
+-- minimap
+L.Minimap_Tooltip_Enabled = "%s"
+L.Minimap_Tooltip_Disabled = "%s " .. cGray("(inaktiv)")
+L.Minimap_Tooltip_Options_Left = "Linksklick"
+L.Minimap_Tooltip_Options_Right = "\195\150ffnet oder schlie\195\159t die Einstellungen."
+L.Minimap_Tooltip_Mappings_Left = "Rechtsklick"
+L.Minimap_Tooltip_Mappings_Right = "Aktiviert oder Deaktivert jegliche Ersetzungen."
 
 -- options
 L.Options_Title = "%s Einstellungen"
@@ -30,10 +62,6 @@ L.Options_Enabled_Name = "Aktiv"
 L.Options_Enabled_Desc = "Aktiviert %s"
 L.Options_Minimap_Button_Name = "Zeige Minimap-Knopf"
 L.Options_Minimap_Button_Desc = "Zeigt oder versteckt den Knopf an der Miniaturkarte"
-L.Options_Minimap_Tooltip_Options_Left = "Linksklick"
-L.Options_Minimap_Tooltip_Options_Right = "\195\150ffnet oder schlie\195\159t die Einstellungen."
-L.Options_Minimap_Tooltip_Mappings_Left = "Rechtsklick"
-L.Options_Minimap_Tooltip_Mappings_Right = "\195\150ffnet das Debug-Fenster mit Ersetzungscode."
 
 L.Options_Channels_Group_Name = "Kan\195\164le"
 L.Options_Channels_Group_Desc = "%s ist in folgenden Kan\195\164len aktiv."
@@ -73,25 +101,484 @@ L.Options_Replacements_Add_Desc = "F\195\188gt eine neue Zuordnung hinzu."
 L.Options_Replacements_DeleteAll_Name = "Alle L\195\182schen"
 L.Options_Replacements_DeleteAll_Desc = "L\195\182scht alle Zuweisungen."
 L.Options_Replacements_DeleteAll_ConfirmText="Wirklich ALLE Zuweisungen l\195\182schen?"
-L.Options_Replacements_Header = "Die Vorkommen links vom Pfeil ( => ) werden in den aktivierten Kan\195\164len gesucht und durch den Text rechts vom Pfeil ersetzt."
+L.Options_Replacements_Header = "Die Vorkommen links vom Pfeil \"=>\" werden in den aktivierten Kan\195\164len gesucht und durch den Text rechts vom Pfeil ersetzt."
-                                .."|nWird die Gro\195\159- und Kleinschreibung ignoriert, wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen."
+
-                                .."|nDas Zusammenfassen aufeinanderfolgender Treffer vermeidet unsch\195\182ne Wiederholungen, die durch die Ersetzung entstehen k\195\182nnen."
-                                .."|nMit den beiden Standard-Ersetzung wird so aus \"Tasse\" => \"Ckache\"."
 L.Options_Mapping_Group_Name = "%s => %s"
 L.Options_Mapping_Group_Desc = "Dieses Vorkommen wird in den aktivierten Kan\195\164len ersetzt."
 L.Options_Mapping_EmptyMapping = "(keine)"
+L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_MoveUp_Desc = "nach oben verschieben"
+L.Options_Mapping_MoveDown_Name = "v"
+L.Options_Mapping_MoveDown_Desc = "nach unten verschieben"
+L.Options_Mapping_MatchWhen_Name = "wann:"
+L.Options_Mapping_MatchWhen_Desc = "F\195\188hrt die Ersetzung nur durch, wenn der Suchtext |nirgendwo vorkommt (<immer>), |nwenn der Suchtext <als ganzes Wort> \195\188bereinstimmt, |n<nur am Anfang eines Worts>, |noder <nur am Ende eines Worts>, |noder <nur am Anfang oder Ende eines Worts> aber nicht dazwischen, |noder nur in der Wortmitte aber <nie am Anfang und Ende eines Worts>."
+L.Options_Mapping_MatchWhen_Select1 = "nie (deaktivert)"
+L.Options_Mapping_MatchWhen_Select2 = "immer"
+L.Options_Mapping_MatchWhen_Select3 = "als ganzes Wort"
+L.Options_Mapping_MatchWhen_Select4 = "nur am Anfang eines Worts"
+L.Options_Mapping_MatchWhen_Select5 = "nur am Ende eines Worts"
+L.Options_Mapping_MatchWhen_Select6 = "nur am Anfang oder Ende eines Worts"
+L.Options_Mapping_MatchWhen_Select7 = "nie am Anfang und Ende eines Worts"
 L.Options_Mapping_SearchText_Name = "Suchtext:"
 L.Options_Mapping_SearchText_Desc = "Dieser Text wird in der Chateingabe gesucht."
 L.Options_Mapping_ReplaceText_Name = "Ersetzung:"
 L.Options_Mapping_ReplaceText_Desc = "Jeder Suchtreffer wird mit diesem Text ersetzt."
 L.Options_Mapping_ExactCase_Name = "Exakte Gro\195\159- und Kleinschreibung"
 L.Options_Mapping_ExactCase_Desc = "Wenn gesetzt, muss die Gro\195\159- und Kleinschreibung des Suchtextes exakt \195\188berein stimmen. Anderfalls wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen."
-L.Options_Mapping_Consolidate_Name = "Fasse aufeinanderfolgende Treffer zusammen"
+L.Options_Mapping_Consolidate_Name = "Zusammenfassen aufeinanderfolgender Treffer"
 L.Options_Mapping_Consolidate_Desc = "Wenn durch die Ersetzung die Zeichenfolge mehrfach hintereinander steht,|nfasse sie zu einem Vorkommen zusammen."
-L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_StopOnMatch_Name = "Anhalten nach Treffer"
-L.Options_Mapping_MoveUp_Desc = "nach oben verschieben"
+L.Options_Mapping_StopOnMatch_Desc = "F\195\188hrt keine nachfolgenden Ersetzungen mehr durch, wenn dieser Eintrag ein Suchtreffer war."
-L.Options_Mapping_MoveDown_Name = "v"
-L.Options_Mapping_MoveDown_Desc = "nach unten verschieben"
 L.Options_Mapping_Delete_Name = "L\195\182schen"
 L.Options_Mapping_Delete_Desc = "L\195\182scht diese Zuweisung."
 L.Options_Mapping_Delete_ConfirmText="Diese Zuweisung l\195\182schen?"
+
+L.Options_Help_Group_Name = "Hilfe"
+L.Options_Help_Group_Desc = "Hilfstellungen zu den Suchmustern und zur Ersetzungslogik."
+L.Options_Help_Disclaimer = cYellow("Haftungsausschlu\195\159:") .. " Das Addon wird im reinen Ist-Zustand zur Verf\195\188gung gestellt, ohne Garantie auf Funktion und Fehlerfreiheit (f\195\188r mehr Details siehe GPL 3 Lizenzdokument). "
+                            .. "Ferner \195\188bernimmt der Autor keinerlei Haftung oder Gew\195\164hrleistung f\195\188r durch das Addon oder dessen Nutzung entstandene Fehler oder Sch\195\164den, "
+                            .. "insb. den Verlust von Spielfortschritt oder Daten aufgrund von Abst\195\188rzen des WoW-Clients."
+L.Options_Help_Tab_Info_Name = "Info"
+L.Options_Help_Tab_Info_Desc = "\195\156ber dieses Addon."
+L.Options_Help_Tab_Basics_Name = "Grundlagen"
+L.Options_Help_Tab_Basics_Desc = "Erl\195\164utert die Grundlagen des Addons"
+L.Options_Help_Tab_Expert_Name = "Experte"
+L.Options_Help_Tab_Expert_Desc = "Beleuchtet die Besonderheiten bei der Textsuche."
+L.Options_Help_Tab_Examples_Name = "Beispiele"
+L.Options_Help_Tab_Examples_Desc = "Beispiele f\195\188r bestimmte Szenarien."
+
+L.Options_Help_Info = cYellow("\195\156ber dieses Addon")
+                        .. "|n%s ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Die Ersetzung findet vor dem Versenden an andere Spieler oder Kanäle statt. "
+                        .. "Es \195\164ndert nicht den Text den andere Spieler im Chat geschrieben haben, nur eure eigenen Eingaben. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erh\195\182hen."
+                        .. "|n|nNat\195\188rlich kann man es auch f\195\188r andere Dinge zweckentfremden (Trollifizierer, Abk\195\188rzungen, Kosenamen, etc.). Eine ausf\195\188hrliche Beschreibung aller Optionen, der Funktionsweise und viele Beispiele befinden sich auf den nachfolgenden Reitern."
+                        .. "|n|n" .. cYellow("Kontakt")
+                        .. "|nBitte Fehler und Erfahrungsberichte direkt als Kommentar auf der Projektwebseite bei " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. ") einmelden. "
+                        .. "Ihr k\195\182nnt auch gern Screenshots der Fehlermeldungen und eurer Zuweisungen anh\195\164ngen. Ein \195\156bersichtsfenster aller Mappings kann mit dem Kommando " .. cPrefix("\"/gri mappings\"") .. " aufgerufen und herauskopiert werden. "
+                        .. "|nIch freue mich \195\188ber euere Erfahrungsberichte und Fehlerreports."
+                        .. "|n|n" .. cYellow("Dank")
+                        .. "|nMein Dank geht an meine lieben Beta-Tester " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " und " .. cPrefix("Nordraka") .. ", und besondereren Dank an " .. cPrefix("Shinue") .. " f\195\188r die Inspiration und lustigen Momente."
+L.Options_Help_Basics = cYellow("Reihenfolge")
+                        .. "|nEs sind unbegrenzt viele Textersetzung m\195\182glich, und sie werden in der Reihenfolge der definierten Zuordnungen abgearbeitet, von oben nach unten. "
+                        .. "Ersetzungen sind transitiv, d.h. nachfolgende Zuordnungen beziehen sich nicht auf den Originaltext, sondern das Resultat der vorherigen Ersetzung. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"a\" => \"b\"") .. " und " .. cPrefix("\"b\" => \"c\"") .. " wird bei Eingabe von " .. cPrefix("\"a\" => \"c\"") .. "."
+                        .. "|n|n" .. cYellow("Exakte Gro\195\159- und Kleinschreibung")
+                        .. "|nBei exakter Gro\195\159- und Kleinschreibung muss die Schreibweise genau \195\188berstimmen, sonst wird diese Zuordnung \195\188bersprungen. "
+                        .. "Wird die Gro\195\159- und Kleinschreibung ignoriert, wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"aBcDeF\" => \"uvWXYz\"") .. " wird aus " .. cPrefix("\"abcdef\" => \"uvwxyz\"") .. ", "
+                        .."aus " .. cPrefix("\"ABCDEF\" => \"UVWXYZ\"") .. " und aus " .. cPrefix("\"AbCdEf\" => \"UvWxYz\"") .. "."
+                        .. "|n|n" .. cYellow("Zusammenfassen aufeinanderfolgender Treffer")
+                        .. "|nDas Zusammenfassen aufeinanderfolgender Treffer vermeidet unsch\195\182ne Wiederholungen, die durch die Ersetzung entstehen k\195\182nnen. "
+                        .. "Die Zusammenfassung wird erst nach der Ersetzung vorgenommen, d.h. am vollst\195\164ndig ersetzten Text f\195\188r alle Zuordnungen. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"s\" => \"sch\"") .. " wird aus " .. cPrefix("\"Tasse\" => \"Tasche\"") .. " statt " .. cPrefix("\"Taschsche\"") .. ", "
+                        .. "aber aus " .. cPrefix("\"schmeissen\" => \"schchmeischen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung: " .. cPrefix("\"schch\" => \"sch\"") .. "."
+                        .. "|n|n" .. cYellow("Anhalten nach Treffer")
+                        .. "|nAlle nachfolgenden Ersetzungen mehr \195\188bersprungen, wenn die aktuelle Zuordnung zutreffend ist. Wenn bei der aktuelle Zuordnung kein Treffer vorliegt, werden die restlichen Zuordnung ganz normal weiter abgearbeitet."
+L.Options_Help_Expert = cYellow("verk\195\188rzende/verl\195\163ngernde Ersetzungen")
+                        .. "|nIst der Ersetzungstext k\195\188rzer als der eigentliche Suchtext, werden die \195\188bersch\195\188\195\159igen Zeichen des Suchtreffers entfernt. "
+                        .. "Ist der Ersetzungstext l\195\163nger, werden die \195\188brigen Zeichen nach dem Treffer hinten drangehangen. Dabei wird die Gro\195\159- und Kleinschreibung des letzten Zeichens ber\195\188cksichtigt, "
+                        .. "ebenso wie die Gro\195\159- und Kleinschreibung des nachfolgenden Zeichens. Gro\195\159geschriebene Abk\195\188rzungen und Ausdr\195\188cke bleiben so einheitlich. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"Kr\195\164uter\" => \"Gr\195\188nzeugs\"") .. " wird aus " .. cPrefix("\"KR\195\132UTER\" => \"GR\195\156NZEUGS\"") .. " statt " .. cPrefix("\"GR\195\156NZEUgs\"") .. " "
+                        .. "unter Beibehaltung von absichtlicher Gro\195\159schreibung wie " .. cPrefix("\"Kr\195\132utERGarten\" => \"Gr\195\156nzEUGSgarten\"") .. " statt " .. cPrefix("\"Gr\195\188nzeugsGarten\"") .. "."
+                        .. "|n|n" .. cYellow("Standby")
+                        .. "|nErsetzungen k\195\182nnen auch nur bei Bedarf durchgef\195\188hrt werden, selbst wenn das Addon oder ein Kanal deaktivert wurde. "
+                        .. "Vor der Eingabe in der Chatbox schreibt man " .. cPrefix("/gri").. " oder " .. cPrefix("/grichelde").. " und optional noch den Zielkanal "
+                        .. "z.B. " .. cPrefix("\"/gri /g Hallo Leute\"") .. " und alle aktiven Zuordnungen werden ersetzt, selbst wenn der Gildenkanal oder das Addon nicht aktiv sind."
+                        .. "|n|n" .. cYellow("Regul\195\164re Ausdr\195\188cke")
+                        .. "|nRegEx sind sehr m\195\163chtige Such- und Ersetzunsgmuster die h\195\163ufig in der Programmierung verwendet werden. Generell werden RegEx in den Suchtexten \195\188bernommen, "
+                        .. "aber Lua unterst\195\188tzt nicht den vollst\195\163ndigen Umfang von PCRE. Trotzdem funktionieren viele Muster wie Anker bei Zeilenanfang " .. cPrefix("\"^\"") .. " oder Zeilenende " .. cPrefix("\"$\"")
+                        .. ", Gruppen " .. cPrefix("\"(Hallo) (Welt)\"") .. "Zeichenklassen wie Zahlen " .. cPrefix("\"%d\"") .. " oder (negierte) Auswahlen " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "Auf Gruppen kann im Ersetzungtext mit %<Nummer> zugegriffen werden" .. cPrefix("\"%2 %1\"") .. "."
+                        .. "|nIm Beispiel-Reiter gibt es einige Ersetzungen, welche mit regul\195\164ren Ausdr\195\188cke umgesetzt wurden."
+
+L.Options_Help_Examples_Note = cYellow("Hinweis:") .. " Dieses Addon bef\195\188rwortet nicht und beabsichtig nicht Personen mit (Fremd-)Sprachproblemen |nzu verletztem oder herabzuw\195\188rdigen. Die Verantwortung f\195\188r den Einsatz des Addons obliegt dem Benutzer. |nBitte verwendet die Funktion respektvoll und zur\195\188ckhaltend gegen\195\188ber anderen Mitspielern."
+L.Options_Help_Examples_Header = cYellow("Beispiel")
+L.Options_Help_Examples_Text = "Bitte ein Beispiel aus der Auswahlbox ausw\195\164hlen."
+L.Options_Help_Examples_Import_Name = "Importieren"
+L.Options_Help_Examples_Import_Desc = "Importiert das ausgew\195\164hlte Beispiel in ein neues Profil %s."
+L.Options_Help_Examples_Import_ConfirmText = "Wird das Beispiel %s in das neue Profil %s importieren."
+
+L.Options_Help_Examples = {
+    {
+        name = "fehlender Unterkiefer",
+        desc = cYellow("S und P werden durch Zisch- und Klacklaute ersetzt."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "t",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "p",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Trollifizierung",
+        desc = cYellow("L\195\164\195\159t euch fast wie Vol'jin klingen."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, maan%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "ir(r?)",
+                replaceText = "ia",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "ch",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "g",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "qu",
+                replaceText = "kw",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "t",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Jar Jar Binks",
+        desc = cYellow("L\195\164\195\159t euch sprechen wie ein ungeschickter Gungan"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "ver",
+                replaceText = "va",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "en",
+                replaceText = "'n",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "(%w?)ich",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "(d?m?)ir",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "du",
+                replaceText = "du da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "erse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "sie",
+                replaceText = "sie da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "wir",
+                replaceText = "wirse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19= {
+                order = 19,
+                searchText = "ihr",
+                replaceText = "ihrse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "nicht",
+                replaceText = "nich",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "die",
+                replaceText = "de",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Altmodisch",
+        desc = cYellow("Benutzt eine antiquiertere Schreibweise."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "ei",
+                replaceText = "ey",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "eu",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "\195\159",
+                replaceText = "sz",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Abk\195\188rzungen",
+        desc = cYellow("Viel sagen, wenig tippen."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "gz",
+                replaceText = "Herzlichen Gl\195\188ckwunsch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "gn8",
+                replaceText = "Gute Nacht",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "afk",
+                replaceText = "Bin mal kurz weg. (AFK)",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "MC",
+                replaceText = "Geschmolzener Kern",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Eigen-, Kose- und Ortsnamen",
+        desc = cYellow("Ersetzt Spielernamen, NPCs oder Orte durch andere Ausdr\195\188cke."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "Sylvanas",
+                replaceText = "die rachs\195\188chtige Bansheek\195\182nigin",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "R\195\188tzkn\195\188bbel",
+                replaceText = "R\195\188tzi",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "Unterstadt",
+                replaceText = "Undercity",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Lispeln",
+        desc = cYellow("Aussprache von S und Z wird zu einem Zischlaut"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "sch",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "s",
+                replaceText = "fs",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "z",
+                replaceText = "ts",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "chs",
+                replaceText = "x",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Stottern",
+        desc = cYellow("Wiederholt Vokale am Satzanfang"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+        }
+    },
+}
+
+L.IgnorePattern_Star = "Stern"
+L.IgnorePattern_Circle = "Kreis"
+L.IgnorePattern_Diamond = "Diamant"
+L.IgnorePattern_Triangle = "Dreieck"
+L.IgnorePattern_Moon = "Mond"
+L.IgnorePattern_Square = "Quadrat"
+L.IgnorePattern_Cross = "Kreuz"
+L.IgnorePattern_Skull = "Totenkopf"

localisation/enUS.lua

@@ -1,12 +1,26 @@
-local L = LibStub('AceLocale-3.0'):NewLocale('Grichelde', 'enUS', true)
+-- read namespace from global env
+local AddonName, _ = ...
+local _G = _G
+local Grichelde = _G.Grichelde
+
+local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'enUS', true)
 if not L then return end
 
+local cYellow    = Grichelde.F.cYellow
+local cGray      = Grichelde.F.cGray
+local cHyperlink = Grichelde.F.cHyperlink
+local cPrefix    = Grichelde.F.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.VersionAbbr = "v"
+L.AddonNamePlusVersion = "%s v%s"
-L.AddonLoaded = "%s now helps you with your spelling disabilities."
+L.AddonLoaded = "%s happily assists you with your spelling disabilities now."
+L.AddonUnloaded = "%s patiently waits to support you again when needed."
 L.Upgrade_ToVersion = "Upgrade database to version %s."
 L.Upgrade_Successful = "Upgrade successful."
+L.Upgrade_Error = "Upgrade failed!"
+L.Downgrade_Detected = "Downgrade detected, %s might not work correctly!"
+
 -- debug
 L.Debug_Options = "Options"
 L.Debug_Mappings = "Mappings"
@@ -14,16 +28,33 @@ L.Debug_Mappings_Hint = "The content of this input box is used for debugging pur
 L.Debug_Mappings_Found = "%d mappings found"
 L.Debug_Profile = "Profile"
 
+-- errors
+L.Error_InvalidCommand = "Invalid command"
+L.Error_InvalidChannel = "Invalid channel"
+L.Error_InvalidWhisperTarget = "Invalid whisper target"
+L.Error_UnsupportedChannel = "Unsupported channel"
+
 -- profiles
 L.Profiles_Available = "Available profiles:"
 L.Profiles_Created = "New profile %s created."
 L.Profiles_Loaded = "Profile %s is loaded."
-L.Profiles_Refreshed = "Profil %s refreshed."
+L.Profiles_Activated = "Profile %s activated."
+L.Profiles_Deactivated = "Profile %s deactivated."
+L.Profiles_Refreshed = "Profile %s refreshed."
 L.Profiles_Deleted = "Profile %s deleted."
 L.Profiles_Copied = "Settings applied from profile %s."
-L.Profiles_Reset = "Profil %s reset."
+L.Profiles_Reset = "Profile %s reset."
 L.Profiles_Invalid = "Invalid profile %s!"
 L.Profiles_DeleteError = "The active profile cannot be deleted!"
+L.Profiles_AlreadyExistsError = "The profile %s already exists!"
+
+-- minimap
+L.Minimap_Tooltip_Enabled = "%s"
+L.Minimap_Tooltip_Disabled = "%s " .. cGray("(inactive)")
+L.Minimap_Tooltip_Options_Left = "Left-Click"
+L.Minimap_Tooltip_Options_Right = "Opens or closes the options UI."
+L.Minimap_Tooltip_Mappings_Left = "Right-Click"
+L.Minimap_Tooltip_Mappings_Right = "Enables or disables any replacements."
 
 -- options
 L.Options_Title = "%s Options"
@@ -31,11 +62,6 @@ L.Options_Enabled_Name = "Enabled"
 L.Options_Enabled_Desc = "Enables %s"
 L.Options_Minimap_Button_Name = "Show minimap button"
 L.Options_Minimap_Button_Desc = "Shows or hides the button on the minimap."
-L.Options_Minimap_Tooltip_Options_Left = "Left-Click"
-L.Options_Minimap_Tooltip_Options_Right = "Opens or closes the options UI."
-L.Options_Minimap_Tooltip_Mappings_Left = "Right-Click"
-L.Options_Minimap_Tooltip_Mappings_Right = "Opens the debug window with mapping code."
-
 
 L.Options_Channels_Group_Name = "Channels"
 L.Options_Channels_Group_Desc = "%s is active in the following channels."
@@ -75,13 +101,24 @@ L.Options_Replacements_Add_Desc = "Adds a new replacement mapping."
 L.Options_Replacements_DeleteAll_Name = "Delete All"
 L.Options_Replacements_DeleteAll_Desc = "Deletes all replacement mappings."
 L.Options_Replacements_DeleteAll_ConfirmText = "Do you really want to delete ALL replacement mappings?"
-L.Options_Replacements_Header = "All matches on the lefthand side of the arrow ( => ) will be replaced in activated channels by the text on the righthand side."
+L.Options_Replacements_Header = "All matches on the lefthand side of the arrow \"=>\" will be replaced in activated channels by the text on the righthand side. "
-                                .. "|nIf case sensivity is ignored, the case for each letter of the matching text is taken over when replaced."
+
-                                .. "|nConsolidation of consecutive matches prevent unaesthetic repetitions of letters introduced by replacements."
-                                .. "|nWith both default mappings active, the mapping would be \"Tossing\" => \"Ckoching\"."
 L.Options_Mapping_Group_Name = "%s => %s"
 L.Options_Mapping_Group_Desc = "This lookup will be replaced in activated channels."
 L.Options_Mapping_EmptyMapping = "(none)"
+L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_MoveUp_Desc = "move up"
+L.Options_Mapping_MoveDown_Name = "v"
+L.Options_Mapping_MoveDown_Desc = "move down"
+L.Options_Mapping_MatchWhen_Name = "when:"
+L.Options_Mapping_MatchWhen_Desc = "Replacement is only done if the search text matches either |nanywhere (<always>), |nif the search text mantches <as a whole word>, |nolny at the <start of each word>, |nor at the <end of each word>, |nor <only at the start or end of each word> but not in between, |nor only in the middle of each word, but <never at start or end of any word>."
+L.Options_Mapping_MatchWhen_Select1 = "never (disabled)"
+L.Options_Mapping_MatchWhen_Select2 = "always"
+L.Options_Mapping_MatchWhen_Select3 = "as a whole word"
+L.Options_Mapping_MatchWhen_Select4 = "start of each word"
+L.Options_Mapping_MatchWhen_Select5 = "end of each word"
+L.Options_Mapping_MatchWhen_Select6 = "only at start and end of each word"
+L.Options_Mapping_MatchWhen_Select7 = "never at start or end of any word"
 L.Options_Mapping_SearchText_Name = "Search for:"
 L.Options_Mapping_SearchText_Desc = "This text is looked up in your chat input box."
 L.Options_Mapping_ReplaceText_Name = "Replacement:"
@@ -90,10 +127,502 @@ L.Options_Mapping_ExactCase_Name = "exact case"
 L.Options_Mapping_ExactCase_Desc = "When set, matches must be case-sensitive. Otherwise the case for each letter of the matching text is taken over when replaced."
 L.Options_Mapping_Consolidate_Name = "consolidate consecutive matches"
 L.Options_Mapping_Consolidate_Desc = "If after the replacement a text sequence is repeated|ndirectly after another, treat them as one occurrence."
-L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_StopOnMatch_Name = "stop on match"
-L.Options_Mapping_MoveUp_Desc = "move up"
+L.Options_Mapping_StopOnMatch_Desc = "Stops looking for any following replacements, when this one matched."
-L.Options_Mapping_MoveDown_Name = "v"
-L.Options_Mapping_MoveDown_Desc = "move down"
 L.Options_Mapping_Delete_Name = "Delete"
 L.Options_Mapping_Delete_Desc = "Deletes this replacement mapping."
 L.Options_Mapping_Delete_ConfirmText = "Delete this replacement mapping?"
+
+L.Options_Help_Group_Name = "Help"
+L.Options_Help_Group_Desc = "Guideance to search patterns and replacement logic."
+L.Options_Help_Disclaimer = cYellow("Disclaimer of warranty:") .. " The addon is provided \"AS IS\" and comes without warranty of any kind of function or correctness (for more details, consult the GPL 3 license). "
+                            .."Also the author is not held responsible for any risk or damage the addon or its use might cause, especially lost of progress or data due to crashes of the WoW client."
+
+L.Options_Help_Tab_Info_Name = "Info"
+L.Options_Help_Tab_Info_Desc = "About this addon."
+L.Options_Help_Tab_Basics_Name = "Basics"
+L.Options_Help_Tab_Basics_Desc = "Some explanatory notes the the basic behaviour."
+L.Options_Help_Tab_Expert_Name = "Expert"
+L.Options_Help_Tab_Expert_Desc = "More details on special search options."
+L.Options_Help_Tab_Examples_Name = "Examples"
+L.Options_Help_Tab_Examples_Desc = "Templates for particular scenarios."
+
+L.Options_Help_Info = cYellow("About this addon")
+                        .. "|n%s replaces any characters or words you typed in a chatbox according to your replacement rules and text. The replacement is done before the text is send to other players/in the target channel. "
+                        .. "It does not change text other players have written in the chat, but the text they will see from you. Its purpose is to simulate a speaking disability of your toon and to strengthen immersion in roleplay."
+                        .. "|n|nOf course it can be used for many other things, too (trollifier, abbreviations, nick names, etc.). A extensive description of all options, the general replacement workflow and a lot of examples can be found on the next tabs."
+                        .. "|n|n" .. cYellow("Contact")
+                        .. "|nPlease report errors and your experiences directly as a comment on the project website at " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. "). "
+                        .. "You are encouraged to attach screenshots of error messages and your mappings. An overview of all your mappings is shnown by using the command " .. cPrefix("\"/gri mappings\"") .. " and copy it out. "
+                        .. "|nI'm looking forward for your feedback and reports."
+                        .. "|n|n" .. cYellow("Thanks")
+                        .. "|Many thanks to my beta testers " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " and " .. cPrefix("Nordraka") .. ", and very special thanks to " .. cPrefix("Shinue") .. " for the inspiration and hilarious moments."
+L.Options_Help_Basics = cYellow("Ordering")
+                        .. "|nYou can have an unlimited number of replacements. All mappings will be processed in same order as defined, from top down. "
+                        .. "Replacements are also transitive, so consecutive mappings do not work on the original input but the resulting text from the previous replacements. "
+                        .. "|nBoth mappings " .. cPrefix("\"a\" => \"b\"") .. " and " .. cPrefix("\"b\" => \"c\"") .. " applied, result in the final text " .. cPrefix("\"a\" => \"c\"") .. "."
+                        .. "|n|n" .. cYellow("exact case")
+                        .. "|nIf \"exact case\" is checked, lower and upper case must match exactly to be replaced, otherwise the mapping is skipped. "
+                        .. "If case sensivity is ignored, the case for each letter of the matching text is taken over when replaced. "
+                        .. "|nWith mapping " .. cPrefix("\"aBcDeF\" => \"uvWXYz\"") .. " text results in " .. cPrefix("\"abcdef\" => \"uvwxyz\"") .. ", "
+                        .. "also " .. cPrefix("\"ABCDEF\" => \"UVWXYZ\"") .. " and " .. cPrefix("\"AbCdEf\" => \"UvWxYz\"") .. "."
+                        .. "|n|n" .. cYellow("consolidate consecutive matches")
+                        .. "|nConsolidation of consecutive matches prevent unaesthetic repetitions of letters introduced during replacements. "
+                        .. "Consolidation takes place after all replacements were done, meaning it's applied to the completely replaced text. "
+                        .. "|nWith mapping " .. cPrefix("\"s\" => \"sh\"") .. " text becomes " .. cPrefix("\"tossing\" => \"toshing\"") .. " instead of " .. cPrefix("\"toshshing\"") .. ", yet still " .. cPrefix("\"paths\" => \"pathsh\"") .. ". "
+                        .. "Such edge cases can usually be mitigated with an additional mapping at the end: " .. cPrefix("\"thsh\" => \"thz\"") .. "."
+                        .. "|n|n" .. cYellow("stop on match")
+                        .. "|nAll other consecutive replacements are skipped, when the current mapping matched. When the current mapping does not match, the remaining mappings are processed as usual."
+L.Options_Help_Expert = cYellow("shortening/lengthening replacements")
+                        .. "|nIf the replacement is shorter than the actual match, all remaining characters will be skipped. If the replacement is longer, all remaining characters will be appended. "
+                        .. "The case of the replaced character is considered as well as the case of the next character in the original text. That way capital case abbreviations and expressions will not be distorted. "
+                        .. "|nWith mapping " .. cPrefix("\"Body\" => \"Corpse\"") .. " the input becomes " .. cPrefix("\"BODY\" => \"CORPSE\"") .. " instead of " .. cPrefix("\"CORPse\"") .. " "
+                        .. "but still keeps intended exceptions like " .. cPrefix("\"BodYGuard\" => \"CorPSEGuard\"") .. " instead of " .. cPrefix("\"CorpseGuard\"") .. ". "
+                        .. "|n|n" .. cYellow("On-Demand")
+                        .. "|nFor convenience input text in a chatbox can be forcefully replaced, even if the addon or the channel was disabled. "
+                        .. "In the chatbox put " .. cPrefix("/gri") .. " or " .. cPrefix("/grichelde") .. " in front of your typed text, you can also include the target channel, "
+                        .. "i.e. " .. cPrefix("\"/gri /guild hello there\"") .. " and the active replacements are applied even if the guild channel or global switch was disabled."
+                        .. "|n|n" .. cYellow("Regular Expressions")
+                        .. "|nRegEx are very powerful search and replacement patterns commonly used in programming. Technically all searches the addon performs on the input are done with regular expression methods, "
+                        .. "however Lua unfortunately does not support full PCRE syntax and is very limited. Nevertheless some patterns can be used like the anchors start of line " .. cPrefix("\"^\"") .. " or end of line " .. cPrefix("\"$\"")
+                        .. ", capturing groups " .. cPrefix("\"(hello) (world)\"") .. "character classes like numbers " .. cPrefix("\"%d\"") .. " or (inversed) sets " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "Capture groups can be accessed in the replacement text with %<number> like in " .. cPrefix("\"%2 %1\"").. "."
+                        .. "|nAlso there are some mappings using RegEx in the Example section."
+
+L.Options_Help_Examples_Note = cYellow("Note:") .. " This addon does not encourange or intend to hurt or to tease people with speaking disabilities or language disorders. The responsibility rest on the user completely. Please use the features with care and respect to other players."
+L.Options_Help_Examples_Header = cYellow("Example")
+L.Options_Help_Examples_Text = "Select an example from the dropdown above."
+L.Options_Help_Examples_Import_Name = "Import"
+L.Options_Help_Examples_Import_Desc = "Imports the selected example into a new profile."
+L.Options_Help_Examples_Import_ConfirmText = "This will import the example %s into the nre profile %s."
+
+L.Options_Help_Examples = {
+    {
+        name = "absent jaw",
+        desc = cYellow("S and P will be replaced by sibilant and clack sounds."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "t",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "p",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "trollifier",
+        desc = cYellow("Almost sound like Vol'jin."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, mon%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "what are you",
+                replaceText = "whatcha",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "your?s?",
+                replaceText = "ya",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "going to",
+                replaceText = "gonna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "want to",
+                replaceText = "wanna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Jar Jar Binks",
+        desc = cYellow("Lets you sound like a clumsy Gungan"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "me",
+                replaceText = "mesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "I am",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "I'm",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "I",
+                replaceText = "Me",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "you are",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "you're",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "your",
+                replaceText = "yous",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "(s?)he is",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "(s?)he's",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "they",
+                replaceText = "daysa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "them",
+                replaceText = "them-sa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_22 = {
+                order = 22,
+                searchText = "the",
+                replaceText = "da",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_23 = {
+                order = 23,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_24 = {
+                order = 24,
+                searchText = "yes",
+                replaceText = "yesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_25 = {
+                order = 25,
+                searchText = "oka?y?",
+                replaceText = "okeeday",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "old-fashioned",
+        desc = cYellow("Use an outdated pronounciation."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "oi",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^aeiou]*)([aeiou])",
+                replaceText = "%1%2e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "yours",
+                replaceText = "thy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "youe",
+                replaceText = "thou",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "abbreviations",
+        desc = cYellow("Say much, type less."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "gz",
+                replaceText = "Congratulations",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "gn8",
+                replaceText = "Good night",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "afk",
+                replaceText = "I'm temporarily unavailable (AFK)",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "MC",
+                replaceText = "Molten Core",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Proper names",
+        desc = cYellow("Replace player names, NPCs or locations."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "Sylvanas",
+                replaceText = "the revengeful banshee queen",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "Asmon",
+                replaceText = "Asmongold",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "x%-?roads",
+                replaceText = "Crossroads",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Lisp",
+        desc = cYellow("S and Z will become sibilant"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "th",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "ch",
+                replaceText = "tsh",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "z",
+                replaceText = "tsh",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "dg",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "stammer",
+        desc = cYellow("Repeats vowels at the beginning of a sentence"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+        }
+    },
+}
+
+L.IgnorePattern_Star = "Star"
+L.IgnorePattern_Circle = "Circle"
+L.IgnorePattern_Diamond = "Diamond"
+L.IgnorePattern_Triangle = "Triangle"
+L.IgnorePattern_Moon = "Moon"
+L.IgnorePattern_Square = "Square"
+L.IgnorePattern_Cross = "Cross"
+L.IgnorePattern_Skull = "Skull"

twitch/announcements.txt

@@ -0,0 +1,17 @@
+https://wow.gamepedia.com/Localizing_an_addon
+https://wow.gamepedia.com/Pattern_matching
+https://wow.gamepedia.com/Lua_functions#String_Functions
+https://wow.gamepedia.com/API_SetRaidTarget
+https://www.wowace.com/projects/ace3/pages/ace-db-3-0-tutorial
+https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0
+https://wowwiki.fandom.com/wiki/Events_A-Z_(full_list)
+
+
+Liebe RP-Gemeinde, ich benötige eure Mithilfe beim Test meines ersten WoW-Addons. :handshake: 
+
+Es heißt "Grichelde" und ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Es ändert nicht den Text den andere im Chat geschrieben haben, nur eure eigenen Eingaben. Die Idee wurde nach mehreren lustigen RP-Sitzungen mit einer Untoten ohne Unterkiefer geboren, deren Spielerin den Sprachfehler immer mühsam per Hand eintippen musste. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erhöhen. Auf der Webseite findet ihr ein paar Screenshots, die euch die Funktion einfach verbildlichen sollten: https://www.curseforge.com/wow/addons/grichelde/screenshots
+
+Natürlich kann man es auch für andere Dinge zweckentfremden (Trollifizierer :dragon_face: , Abkürzungen, Kosenamen, etc.). Es gibt ein nettes UI zum Konfigurieren der Ersetzungen und der aktiven Kanäle und auch eine großzügige Hilfesektion mit vielen Beispielen. Die Suchtreffer können auf ganze Wörter oder am Anfang, der Mitte und/oder am Ende eines Wortes eingeschränkt werden. Für die Profis gibt es sogar Unterstützung für reguläre Ausdrücke :sunglasses:, das ermöglicht auch schwierigere Ersetzungen mit Wiederholungen, wie Stottern. Für Rollenspieler gibts auch eine eigene Emote- und OOC-Erkennung.
+
+Installieren kann man es über Twitch, dort muss aktuell noch die Suche und Installation von Beta-Versionen aktiviert sein, oder manuell über diesen Link runterladen und in den WoW\Interface\Addons Ordner kopieren: https://www.curseforge.com/wow/addons/grichelde
+Bitte Fehler auf der Projektwebseite bei CurseForge einmelden, damit wir den Discord nicht zweckentfremden. Ich freue mich über euere Erfahrungsberichte und Fehlerreports.

twitch/image-descriptions.txt

@@ -0,0 +1,49 @@
+Sample replacement
+Text is replaced in the "Say" channel.
+
+Replacements
+Define your own set of replacements rules
+
+Replacements
+Create multiple mappings between search text and replacement with additional conditions.
+
+Channel configuration
+individual channel activation
+
+Profiles
+global, per server, per class, per character or custom
+
+Examples
+Templates for various situations, now also with import possibility
+
+Help
+Built-in help texts
+
+Confirm text changes
+When you enter a search or replacement text, please confirm your input with the Okay button. Otherwise its not saved.
+
+
+
+Beispielersetzung
+Eine Texteingabe wird im "Sagen"-Kanal ersetzt.
+
+Zeichenersetzung
+Erzeuge bedingte Zuordnungen zwischen Such- und Ersetzungstext.
+
+Kanälekonfiguration
+einzeln pro Kanal aktivierbar
+
+Profile:
+Global, pro Server, pro Klasse, pro Character
+
+Neu: Beispiele
+Vorlagen für verschiedene Zwecke, jetzt mit Import-Funktion
+
+
+
+Error Reporting
+In case of errors please send me the exact error message and please also provide the mapping from "/gri mappings" (see next screen).
+
+
+Debug Mappings
+In case of errors please send me the exact error message and please also provide the mapping from "/gri mappings"