Version 0.8.0-beta

- handle replacement via slash command
- emote and ooc detection
- de-/activate single mappings
- move buttons and mappings are disabled when already at top/bottom or deactivated
- minimap button is darkened when addon is disabled
- help tab with examples

- 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

localisation/deDE.lua

@@ -1,18 +1,36 @@
-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.functions.cYellow
+local cGray = Grichelde.functions.cGray
+local cPrefix = Grichelde.functions.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.VersionAbbr = "v"
-L.AddonLoaded = "%s hilft Euch jetzt bei euren Sprachschwierigkeiten."
+L.AddonNamePlusVersion = "%s v%s"
+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."
+
+-- 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."
@@ -24,16 +42,20 @@ 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!"
 
+-- 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"
 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 +95,105 @@ 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."
-                                .."|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_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_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_Enabled_Name = "Aktiv"
+L.Options_Mapping_Enabled_Desc = "Diese Ersetzung wird durchgef\195\188hrt"
 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_StopOnMatch_Name = "Anhalten nach Treffer"
+L.Options_Mapping_StopOnMatch_Desc = "F\195\188hrt keine nachfolgenden Ersetzungen mehr durch, wenn dieser Eintrag ein Suchtreffer war."
 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_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_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_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_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 findet keine Textersetzug f\195\188r diese Zuordnung statt. "
+                        .. "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 jede Zuordnung. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"s\" => \"sch\"") .. " wird aus " .. cPrefix("\"Tasse\" => \"Tasche\"") .. " statt " .. cPrefix("\"Taschsche\"") .. ", "
+                        .. "aber " .. cPrefix("\"schmeissen\" => \"schchmeischen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung wie " .. cPrefix("\"chch\" => \"ch\"") .. "."
+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\" => \"Gr195\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 /p hallo da dr\195\188ben\"") .. " und alle aktiven Zuordnungen werden ersetzt, selbst wenn der Gruppenkanal 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. Technisch gesehen benutzt das Addon f\195\188r die Suchen des Eingabetextes bereits regul\195\163ren Ausdr\195\188cke. "
+                        .. "Das Eingeben von RegEx als Suchtext ist allerings eine inoffizielle Funktion und hat zwei gro\195\159e Einschr\195\163nkungen: "
+                        .. "|n1. Leider unterst\195\188tzt Lua nicht den vollst\195\163ndigen Umfang von PCRE. Trotzdem k\195\182nnen einige Muster verwendet werden wie Zeilenanfang " .. cPrefix("\"^\"") .. " "
+                        .."oder Zeilenende " .. cPrefix("\"$\"") .. ", Zeichenklassen wie Zahlen " .. cPrefix("\"%d\"") .. " oder (negierte) Auswahlen " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "|n2. Es werden keine Gruppen im Ersetzungstest unterst\195\188tzt, so da\195\159 Gruppen einfach verloren gehen. Wegen der Gro\195\159- und Kleinschreibung und steigender Komplexit\195\163t ist diese Funktion auch f\195\188r die Zukunft nicht geplant. "
+                        .. "|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_Examples0_Header = cYellow("Beispiel")
+L.Options_Help_Examples0_Text = "Bitte ein Beispiel aus der Auswahlbox ausw\195\164hlen."
+L.Options_Help_Examples1_Select = "fehlender Unterkiefer"
+L.Options_Help_Examples1_Header = cYellow("S und P werden durch Zisch- und Klacklaute ersetzt.")
+L.Options_Help_Examples1_Text = cPrefix("s => ch") .. "|n|n" .. cPrefix("t => ck")
+L.Options_Help_Examples2_Select = "Trollifizierung"
+L.Options_Help_Examples2_Header = cYellow("L\195\164\195\159t euch fast wie ein echter Troll klingen.")
+L.Options_Help_Examples2_Text = cPrefix("%.$ => , maan.") .. "|n|n" .. cPrefix("ir => ia") .. "|n|n" .. cPrefix("ch => ck") .. "|n|n" .. cPrefix("g => ch") .. "|n|n" .. cPrefix("qu => kw") .. "|n|n" .. cPrefix("t => d")
+L.Options_Help_Examples3_Select = "Altmodisch"
+L.Options_Help_Examples3_Header = cYellow("Benutzt eine antiquiertere Schreibweise.")
+L.Options_Help_Examples3_Text = cPrefix("ei => ey") .. "|n|n" .. cPrefix("\195\159 => sz")
+L.Options_Help_Examples4_Select = "Abk\195\188rzungen"
+L.Options_Help_Examples4_Header = cYellow("Viel sagen, wenig tippen.")
+L.Options_Help_Examples4_Text = cPrefix("gz => Herzlichen Gl\195\188ckwunsch") .. "|n|n" .. cPrefix("gn8 => Gute Nacht") .. "|n|n" .. cPrefix("afk => Bin mal eben weg (AFK)") .. "|n|n" .. cPrefix("MC => Geschmolzener Kern")
+L.Options_Help_Examples5_Select = "Eigennamen"
+L.Options_Help_Examples5_Header = cYellow("Ersetzt Spielernamen, NPCs oder Orte durch andere Ausdr\195\188cke.")
+L.Options_Help_Examples5_Text = cPrefix("Sylvanas => die rachs\195\188chtige Bansheek\195\182nigin") .. "|n|n" .. cPrefix("R\195\188tzkn\195\188bbel => R\195\188tzi") .. "|n|n" .. cPrefix("Unterstadt => Undercity")
+L.Options_Help_Examples6_Select = "Lispeln"
+L.Options_Help_Examples6_Header = cYellow("Aussprache von S und Z wird zu einem Zischlaut")
+L.Options_Help_Examples6_Text = cPrefix("sch => ch") .. "|n|n" .. cPrefix("s => fs") .. "|n|n" .. cPrefix("z => ts") .. "|n|n" .. cPrefix("chs => x")
+L.Options_Help_Examples7_Select = "Stottern"
+L.Options_Help_Examples7_Header = cYellow("Stottern")
+L.Options_Help_Examples7_Text = "p[%s]-$"
+
+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,23 @@
-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.functions.cYellow
+local cGray = Grichelde.functions.cGray
+local cPrefix = Grichelde.functions.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.VersionAbbr = "v"
-L.AddonLoaded = "%s now helps you with your spelling disabilities."
+L.AddonNamePlusVersion = "%s v%s"
+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."
+
 -- debug
 L.Debug_Options = "Options"
 L.Debug_Mappings = "Mappings"
@@ -14,6 +25,12 @@ 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."
@@ -25,17 +42,20 @@ L.Profiles_Reset = "Profil %s reset."
 L.Profiles_Invalid = "Invalid profile %s!"
 L.Profiles_DeleteError = "The active profile cannot be deleted!"
 
+-- 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"
 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 +95,13 @@ 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."
-                                .. "|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_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_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_Enabled_Name = "active"
+L.Options_Mapping_Enabled_Desc = "This replacement will be processed."
 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 +110,90 @@ 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_StopOnMatch_Name = "stop on match"
+L.Options_Mapping_StopOnMatch_Desc = "Stops looking for any following replacements, when this one matched."
 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_Delete_Name = "Delete"
 L.Options_Mapping_Delete_Desc = "Deletes this replacement mapping."
-L.Options_Mapping_Delete_ConfirmText = "Delete 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_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_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\"") .. "."
+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 text are done with regular expression methods. "
+                        .. "Entering regex as search text however is an unofficial feature and has two major caveats: "
+                        .. "|n1. Unfornately Lua does not support full PCRE syntax and is very limited. Nethertheless some patterns can be used like start of line " .. cPrefix("\"^\"") .. " or end of line " .. cPrefix("\"$\"") .. ", "
+                        .. "character classes like numbers " .. cPrefix("\"%d\"") .. " or (inversed) sets " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "|n2. There is no support for capture groups in the replacement text, so matches get lost. Because of case sensivity and complexity there are no plans to support this."
+                        .. "|nAnyway, there are some mappings using RegEx in the Example secion."
+
+
+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_Examples0_Header = cYellow("Example")
+L.Options_Help_Examples0_Text = "Select an example from the dropdown above."
+L.Options_Help_Examples1_Select = "absent jaw"
+L.Options_Help_Examples1_Header = cYellow("S and P will be replaced by sibilant and clack sounds.")
+L.Options_Help_Examples1_Text = cPrefix("s => ch") .. "|n|n" .. cPrefix("t => ck")
+L.Options_Help_Examples2_Select = "trollifier"
+L.Options_Help_Examples2_Header = cYellow("Almost sound like a real Troll.")
+L.Options_Help_Examples2_Text = cPrefix("%.$ => , mon.") .. "|n|n" .. cPrefix("th => d") .. "|n|n" .. cPrefix("you => ya") .. "|n|n" .. cPrefix("ing => in'")
+L.Options_Help_Examples3_Select = "old-fashioned"
+L.Options_Help_Examples3_Header = cYellow("Use an outdate pronounciation.")
+L.Options_Help_Examples3_Text = cPrefix("oi => oy") .. "|n|n" .. cPrefix("do => doe") .. "|n|n" .. cPrefix("go => goe") .. "|n|n" .. cPrefix("you => thou") .. "|n|n" .. cPrefix("yours => thy") .. "|n|n" .. cPrefix("be => bee") .. "|n|n" .. cPrefix("we => wee")
+L.Options_Help_Examples4_Select = "abbreviations"
+L.Options_Help_Examples4_Header = cYellow("Say much, type less.")
+L.Options_Help_Examples4_Text = cPrefix("gz => Congratulations") .. "|n|n" .. cPrefix("gn8 => Good night") .. "|n|n" .. cPrefix("afk => I'm temporarikly not available (AFK)") .. "|n|n" .. cPrefix("MC => Molten Core")
+L.Options_Help_Examples5_Select = "Proper names"
+L.Options_Help_Examples5_Header = cYellow("Replace player names, NPCs or locations.")
+L.Options_Help_Examples5_Text = cPrefix("Sylvanas => the revengeful banshee queen") .. "|n|n" .. cPrefix("Asmongold => Asmon") .. "|n|n" .. cPrefix("Crossroads => X-roads")
+L.Options_Help_Examples6_Select = "lisp"
+L.Options_Help_Examples6_Header = cYellow("S and Z will become a sibilant")
+L.Options_Help_Examples6_Text = cPrefix("s => th") .. "|n|n" .. cPrefix("ch => tsh") .. "|n|n" .. cPrefix("z => tsh") .. "|n|n" .. cPrefix("dg => ck")
+L.Options_Help_Examples7_Select = "stammer"
+L.Options_Help_Examples7_Header = cYellow("stammer")
+L.Options_Help_Examples7_Text = "p[% s]-$"
+
+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"