From 148fc685902d524cc0be0c3960511fc28103382e Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Mon, 16 Jun 2025 18:46:37 +0200
Subject: [PATCH] Add markdown highlight format

---
 novelwriter/constants.py                 |  1 +
 novelwriter/formats/shared.py            | 10 +++++++++-
 novelwriter/formats/tokenizer.py         |  1 +
 novelwriter/gui/dochighlight.py          | 19 ++++++++++++++++---
 novelwriter/text/patterns.py             |  6 ++++++
 sample/content/636b6aa9b697b.nwd         |  6 +++---
 sample/nwProject.nwx                     |  8 ++++----
 tests/test_formats/test_fmt_tokenizer.py |  5 +++++
 8 files changed, 45 insertions(+), 11 deletions(-)

diff --git a/novelwriter/constants.py b/novelwriter/constants.py
index 701ac5a1..e47455d8 100644
--- a/novelwriter/constants.py
+++ b/novelwriter/constants.py
@@ -77,6 +77,7 @@ class nwRegEx:
     FMT_EI = r"(?<![\w\\])(_)(?![\s_])(.+?)(?<![\s\\])(\1)(?!\w)"
     FMT_EB = r"(?<![\w\\])(\*{2})(?![\s\*])(.+?)(?<![\s\\])(\1)(?!\w)"
     FMT_ST = r"(?<![\w\\])(~{2})(?![\s~])(.+?)(?<![\s\\])(\1)(?!\w)"
+    FMT_HL = r"(?<![\w\\])(={2})(?![\s=])(.+?)(?<![\s\\])(\1)(?!\w)"
     FMT_SC = r"(?i)(?<!\\)(\[(?:b|/b|i|/i|s|/s|u|/u|m|/m|sup|/sup|sub|/sub|br)\])"
     FMT_SV = r"(?i)(?<!\\)(\[(?:footnote|field):)(.+?)(?<!\\)(\])"
 
diff --git a/novelwriter/formats/shared.py b/novelwriter/formats/shared.py
index 8a2ab5e6..3f7b3a42 100644
--- a/novelwriter/formats/shared.py
+++ b/novelwriter/formats/shared.py
@@ -29,7 +29,15 @@ from enum import Flag, IntEnum
 
 from PyQt6.QtGui import QColor
 
-ESCAPES = {r"\*": "*", r"\~": "~", r"\_": "_", r"\[": "[", r"\]": "]", r"\ ": ""}
+ESCAPES = {
+    r"\*": "*",
+    r"\~": "~",
+    r"\=": "=",
+    r"\_": "_",
+    r"\[": "[",
+    r"\]": "]",
+    r"\ ": "",
+}
 RX_ESC = re.compile("|".join([re.escape(k) for k in ESCAPES.keys()]), flags=re.DOTALL)
 
 
diff --git a/novelwriter/formats/tokenizer.py b/novelwriter/formats/tokenizer.py
index ba355a16..1379fdf6 100644
--- a/novelwriter/formats/tokenizer.py
+++ b/novelwriter/formats/tokenizer.py
@@ -189,6 +189,7 @@ class Tokenizer(ABC):
             (REGEX_PATTERNS.markdownItalic, [0, TextFmt.I_B, 0, TextFmt.I_E]),
             (REGEX_PATTERNS.markdownBold,   [0, TextFmt.B_B, 0, TextFmt.B_E]),
             (REGEX_PATTERNS.markdownStrike, [0, TextFmt.D_B, 0, TextFmt.D_E]),
+            (REGEX_PATTERNS.markdownMark,   [0, TextFmt.M_B, 0, TextFmt.M_E]),
         ]
 
         self._shortCodeFmt = {
diff --git a/novelwriter/gui/dochighlight.py b/novelwriter/gui/dochighlight.py
index 8103fd79..d013b807 100644
--- a/novelwriter/gui/dochighlight.py
+++ b/novelwriter/gui/dochighlight.py
@@ -110,6 +110,7 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         self._addCharFormat("bold",      colEmph, "b")
         self._addCharFormat("italic",    colEmph, "i")
         self._addCharFormat("strike",    syntax.hidden, "s")
+        self._addCharFormat("mark",      syntax.mark, "bg")
         self._addCharFormat("mspaces",   syntax.error, "err")
         self._addCharFormat("nobreak",   colBreak, "bg")
         self._addCharFormat("altdialog", syntax.dialA)
@@ -196,6 +197,17 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         self._txtRules.append((rxRule, hlRule))
         self._cmnRules.append((rxRule, hlRule))
 
+        # Markdown Highlight
+        rxRule = REGEX_PATTERNS.markdownMark
+        hlRule = {
+            1: self._hStyles["markup"],
+            2: self._hStyles["mark"],
+            3: self._hStyles["markup"],
+        }
+        self._minRules.append((rxRule, hlRule))
+        self._txtRules.append((rxRule, hlRule))
+        self._cmnRules.append((rxRule, hlRule))
+
         # Shortcodes
         rxRule = REGEX_PATTERNS.shortcodePlain
         hlRule = {
@@ -437,9 +449,6 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         charFormat = QTextCharFormat()
         charFormat.setFontStyleName(name)
 
-        if color:
-            charFormat.setForeground(color)
-
         if style:
             styles = style.split(",")
             if "b" in styles:
@@ -455,6 +464,10 @@ class GuiDocHighlighter(QSyntaxHighlighter):
                 charFormat.setUnderlineStyle(QTextCharFormat.UnderlineStyle.SpellCheckUnderline)
             if "bg" in styles and color is not None:
                 charFormat.setBackground(QBrush(color, Qt.BrushStyle.SolidPattern))
+                color = None
+
+        if color:
+            charFormat.setForeground(color)
 
         if size:
             charFormat.setFontPointSize(round(size*CONFIG.textFont.pointSize()))
diff --git a/novelwriter/text/patterns.py b/novelwriter/text/patterns.py
index a5d2b3e9..b847f14b 100644
--- a/novelwriter/text/patterns.py
+++ b/novelwriter/text/patterns.py
@@ -42,6 +42,7 @@ class RegExPatterns:
     _rxItalic  = re.compile(nwRegEx.FMT_EI, re.UNICODE)
     _rxBold    = re.compile(nwRegEx.FMT_EB, re.UNICODE)
     _rxStrike  = re.compile(nwRegEx.FMT_ST, re.UNICODE)
+    _rxMark    = re.compile(nwRegEx.FMT_HL, re.UNICODE)
     _rxSCPlain = re.compile(nwRegEx.FMT_SC, re.UNICODE)
     _rxSCValue = re.compile(nwRegEx.FMT_SV, re.UNICODE)
 
@@ -75,6 +76,11 @@ class RegExPatterns:
         """Markdown strikethrough style."""
         return self._rxStrike
 
+    @property
+    def markdownMark(self) -> re.Pattern:
+        """Markdown highlight style."""
+        return self._rxMark
+
     @property
     def shortcodePlain(self) -> re.Pattern:
         """Plain shortcode style."""
diff --git a/sample/content/636b6aa9b697b.nwd b/sample/content/636b6aa9b697b.nwd
index e3d4bfde..12f0d4e0 100644
--- a/sample/content/636b6aa9b697b.nwd
+++ b/sample/content/636b6aa9b697b.nwd
@@ -1,8 +1,8 @@
 %%~name: Making a Scene
 %%~path: 6a2d6d5f4f401/636b6aa9b697b
 %%~kind: NOVEL/DOCUMENT
-%%~hash: 1f3d98a6a27b4f9a7f2239fcd78f9e2263cd3b97
-%%~date: Unknown/2025-05-18 22:36:59
+%%~hash: b85f815702763f58926edd72a2eeed1df5e1cbc9
+%%~date: Unknown/2025-06-16 12:49:10
 ### Making a Scene
 
 @pov: Jane
@@ -15,7 +15,7 @@
 
 A scene is defined by a level three heading, like the one at the top of this page. The scene will be assigned to the chapter preceding it in the project tree. The scene document can be sorted after the chapter document, or as a child of the chapter. Both result in the same output in the end, so it is a matter of preference.
 
-Each paragraph in the scene is separated by a blank line. The text supports minimal formatting, like **bold**, _italic_ and **_bold italic_**. You can also ~~strike through~~ text. There is **some support for _nested_ emphasis**, but there are some known limitations. If the syntax highlighter doesn’t show it correctly, the export tool will not either.
+Each paragraph in the scene is separated by a blank line. The text supports minimal formatting, like **bold**, _italic_ and **_bold italic_**. You can also ~~strike through~~ text. There is **some support for _nested_ emphasis**, but there are some known limitations. If the ==syntax highlighter== doesn’t show it correctly, the export tool will not either.
 
 For special formatting aside from standard emphasis, you can use “shortcodes”. Here we have super[sup]script[/sup] and sub[sub]script[/sub], and [b]part[/b]ial bold too, which ends in the middle of a word. The shortcodes also support [u]underline[/u], and you can [m]highlight text as well[/m].
 
diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx
index 32ed2662..587802ef 100644
--- a/sample/nwProject.nwx
+++ b/sample/nwProject.nwx
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="2.8a0" hexVersion="0x020800a0" fileVersion="1.5" fileRevision="6" timeStamp="2025-06-12 13:04:43">
-  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="2221" autoCount="289" editTime="97582">
+<novelWriterXML appVersion="2.8a1" hexVersion="0x020800a1" fileVersion="1.5" fileRevision="6" timeStamp="2025-06-16 12:51:59">
+  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="2234" autoCount="290" editTime="98009">
     <name>Sample Project</name>
     <author>Jane Smith</author>
   </project>
@@ -36,7 +36,7 @@
       <entry key="i56be10" count="1" color="purple" shape="BLOCK_4">Main</entry>
     </importance>
   </settings>
-  <content items="31" novelWords="1016" notesWords="416" novelChars="5602" notesChars="2285">
+  <content items="31" novelWords="1016" notesWords="416" novelChars="5606" notesChars="2285">
     <item handle="7031beac91f75" parent="None" root="7031beac91f75" order="0" type="ROOT" class="NOVEL">
       <meta expanded="yes" />
       <name status="sc24b8f" import="ia857f0">Novel</name>
@@ -58,7 +58,7 @@
       <name status="sf24ce6" import="ia857f0" active="yes">Chapter One</name>
     </item>
     <item handle="636b6aa9b697b" parent="6a2d6d5f4f401" root="7031beac91f75" order="0" type="FILE" class="NOVEL" layout="DOCUMENT">
-      <meta expanded="no" heading="H3" charCount="2999" wordCount="530" paraCount="16" cursorPos="1225" />
+      <meta expanded="no" heading="H3" charCount="3003" wordCount="530" paraCount="16" cursorPos="1493" />
       <name status="s90e6c9" import="ia857f0" active="yes">Making a Scene</name>
     </item>
     <item handle="bc0cbd2a407f3" parent="6a2d6d5f4f401" root="7031beac91f75" order="1" type="FILE" class="NOVEL" layout="DOCUMENT">
diff --git a/tests/test_formats/test_fmt_tokenizer.py b/tests/test_formats/test_fmt_tokenizer.py
index d141b6ef..2b053e1b 100644
--- a/tests/test_formats/test_fmt_tokenizer.py
+++ b/tests/test_formats/test_fmt_tokenizer.py
@@ -919,6 +919,11 @@ def testFmtToken_ExtractFormats(mockGUI):
     assert text == "Text with strikethrough in it."
     assert fmt == [(10, TextFmt.D_B, ""), (23, TextFmt.D_E, "")]
 
+    # Plain mark
+    text, fmt = tokens._extractFormats("Text with ==a highlight== in it.")
+    assert text == "Text with a highlight in it."
+    assert fmt == [(10, TextFmt.M_B, ""), (21, TextFmt.M_E, "")]
+
     # Nested bold/italics
     text, fmt = tokens._extractFormats("Text with **bold and _italics_** in it.")
     assert text == "Text with bold and italics in it."