novelWriter 2.7.5__py3-none-any.whl → 2.8b1__py3-none-any.whl

novelwriter/config.py

@@ -22,7 +22,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import json
@@ -45,6 +45,7 @@ from novelwriter.common import (
     formatTimeStamp, processDialogSymbols, simplified
 )
 from novelwriter.constants import nwFiles, nwQuotes, nwUnicode
+from novelwriter.enum import nwTheme
 from novelwriter.error import formatException, logException
 
 if TYPE_CHECKING:
@@ -55,13 +56,20 @@ if TYPE_CHECKING:
 
 logger = logging.getLogger(__name__)
 
-DEF_GUI = "default"
-DEF_SYNTAX = "default_light"
+DEF_GUI_DARK = "default_dark"
+DEF_GUI_LIGHT = "default_light"
 DEF_ICONS = "material_rounded_normal"
 DEF_TREECOL = "theme"
 
 
 class Config:
+    """User Config.
+
+    The main user config. The state of the config is stored in the
+    novelwriter.conf file between sessions. Most of the settings can be
+    modified by the user in the Preferences dialog, but some just record
+    various states of the GUI.
+    """
 
     __slots__ = (
         "_appPath", "_appRoot", "_backPath", "_backupPath", "_confPath", "_dLocale", "_dShortDate",
@@ -69,22 +77,23 @@ class Config:
         "_manuals", "_nwLangPath", "_qLocale", "_qtLangPath", "_qtTrans", "_recentPaths",
         "_recentProjects", "_splash", "allowOpenDial", "altDialogClose", "altDialogOpen",
         "appHandle", "appName", "askBeforeBackup", "askBeforeExit", "autoSaveDoc", "autoSaveProj",
-        "autoScroll", "autoScrollPos", "autoSelect", "backupOnClose", "cursorWidth", "dialogLine",
-        "dialogStyle", "doJustify", "doReplace", "doReplaceDQuote", "doReplaceDash",
+        "autoScroll", "autoScrollPos", "autoSelect", "backupOnClose", "cursorWidth", "darkTheme",
+        "dialogLine", "dialogStyle", "doJustify", "doReplace", "doReplaceDQuote", "doReplaceDash",
         "doReplaceDots", "doReplaceSQuote", "emphLabels", "fmtApostrophe", "fmtDQuoteClose",
         "fmtDQuoteOpen", "fmtPadAfter", "fmtPadBefore", "fmtPadThin", "fmtSQuoteClose",
-        "fmtSQuoteOpen", "focusWidth", "guiFont", "guiLocale", "guiSyntax", "guiTheme",
-        "hasEnchant", "hideFocusFooter", "hideHScroll", "hideVScroll", "highlightEmph", "hostName",
-        "iconColDocs", "iconColTree", "iconTheme", "incNotesWCount", "isDebug", "kernelVer",
-        "lastNotes", "mainPanePos", "mainWinSize", "memInfo", "narratorBreak", "narratorDialog",
-        "nativeFont", "osDarwin", "osLinux", "osType", "osUnknown", "osWindows", "outlinePanePos",
-        "prefsWinSize", "scrollPastEnd", "searchCase", "searchLoop", "searchMatchCap",
-        "searchNextFile", "searchProjCase", "searchProjRegEx", "searchProjWord", "searchRegEx",
-        "searchWord", "showEditToolBar", "showFullPath", "showLineEndings", "showMultiSpaces",
-        "showSessionTime", "showTabsNSpaces", "showViewerPanel", "spellLanguage", "stopWhenIdle",
-        "tabWidth", "textFont", "textMargin", "textWidth", "useCharCount", "userIdleTime",
-        "verPyQtString", "verPyQtValue", "verPyString", "verQtString", "verQtValue",
-        "viewComments", "viewPanePos", "viewSynopsis", "welcomeWinSize",
+        "fmtSQuoteOpen", "focusWidth", "guiFont", "guiLocale", "hasEnchant", "hideFocusFooter",
+        "hideHScroll", "hideVScroll", "highlightEmph", "hostName", "iconColDocs", "iconColTree",
+        "iconTheme", "incNotesWCount", "isDebug", "kernelVer", "lastNotes", "lightTheme",
+        "lineHighlight", "mainPanePos", "mainWinSize", "memInfo", "narratorBreak",
+        "narratorDialog", "nativeFont", "osDarwin", "osLinux", "osType", "osUnknown", "osWindows",
+        "outlinePanePos", "prefsWinSize", "scrollPastEnd", "searchCase", "searchLoop",
+        "searchMatchCap", "searchNextFile", "searchProjCase", "searchProjRegEx", "searchProjWord",
+        "searchRegEx", "searchWord", "showEditToolBar", "showFullPath", "showLineEndings",
+        "showMultiSpaces", "showSessionTime", "showTabsNSpaces", "showViewerPanel",
+        "spellLanguage", "stopWhenIdle", "tabWidth", "textFont", "textMargin", "textWidth",
+        "themeMode", "useCharCount", "userIdleTime", "verPyQtString", "verPyQtValue",
+        "verPyString", "verQtString", "verQtValue", "viewComments", "viewNotes", "viewPanePos",
+        "viewSynopsis", "welcomeWinSize",
     )
 
     LANG_NW   = 1
@@ -153,14 +162,15 @@ class Config:
 
         # General GUI Settings
         self.guiLocale    = self._qLocale.name()
-        self.guiTheme     = DEF_GUI     # GUI theme
-        self.guiSyntax    = DEF_SYNTAX  # Syntax theme
-        self.guiFont      = QFont()     # Main GUI font
-        self.hideVScroll  = False       # Hide vertical scroll bars on main widgets
-        self.hideHScroll  = False       # Hide horizontal scroll bars on main widgets
-        self.lastNotes    = "0x0"       # The latest release notes that have been shown
-        self.nativeFont   = True        # Use native font dialog
-        self.useCharCount = False       # Use character count as primary count
+        self.lightTheme   = DEF_GUI_LIGHT  # Light GUI theme
+        self.darkTheme    = DEF_GUI_DARK   # Dark GUI theme
+        self.themeMode    = nwTheme.AUTO   # Colour theme mode
+        self.guiFont      = QFont()        # Main GUI font
+        self.hideVScroll  = False          # Hide vertical scroll bars on main widgets
+        self.hideHScroll  = False          # Hide horizontal scroll bars on main widgets
+        self.lastNotes    = "0x0"          # The latest release notes that have been shown
+        self.nativeFont   = True           # Use native font dialog
+        self.useCharCount = False          # Use character count as primary count
 
         # Icons
         self.iconTheme   = DEF_ICONS    # Icons theme
@@ -178,8 +188,8 @@ class Config:
         # Project Settings
         self.autoSaveProj    = 60     # Interval for auto-saving project, in seconds
         self.autoSaveDoc     = 30     # Interval for auto-saving document, in seconds
-        self.emphLabels      = True   # Add emphasis to H1 and H2 item labels
-        self.backupOnClose   = False  # Flag for running automatic backups
+        self.emphLabels      = False  # Add emphasis to H1 and H2 item labels
+        self.backupOnClose   = True   # Flag for running automatic backups
         self.askBeforeBackup = True   # Flag for asking before running automatic backup
         self.askBeforeExit   = True   # Flag for asking before exiting the app
 
@@ -189,6 +199,7 @@ class Config:
         self.textMargin      = 40       # Editor/viewer text margin
         self.tabWidth        = 40       # Editor tabulator width
         self.cursorWidth     = 1        # Editor cursor width
+        self.lineHighlight   = False    # Highlight current line in editor
 
         self.focusWidth      = 800      # Focus Mode text width
         self.hideFocusFooter = False    # Hide document footer in Focus Mode
@@ -198,7 +209,7 @@ class Config:
         self.doJustify       = False    # Justify text
         self.showTabsNSpaces = False    # Show tabs and spaces in editor
         self.showLineEndings = False    # Show line endings in editor
-        self.showMultiSpaces = True     # Highlight multiple spaces in the text
+        self.showMultiSpaces = False    # Highlight multiple spaces in the text
 
         self.doReplace       = True     # Enable auto-replace as you type
         self.doReplaceSQuote = True     # Smart single quotes
@@ -206,7 +217,7 @@ class Config:
         self.doReplaceDash   = True     # Replace multiple hyphens with dashes
         self.doReplaceDots   = True     # Replace three dots with ellipsis
 
-        self.autoScroll      = False    # Typewriter-like scrolling
+        self.autoScroll      = True     # Typewriter-like scrolling
         self.autoScrollPos   = 30       # Start point for typewriter-like scrolling
         self.scrollPastEnd   = True     # Scroll past end of document, and centre cursor
 
@@ -245,6 +256,7 @@ class Config:
         self.showSessionTime = True   # Show the session time in the status bar
         self.viewComments    = True   # Comments are shown in the viewer
         self.viewSynopsis    = True   # Synopsis is shown in the viewer
+        self.viewNotes       = True   # Notes are shown in the viewer
 
         # Search Box States
         self.searchCase      = False
@@ -295,8 +307,6 @@ class Config:
         # Packages
         self.hasEnchant = False  # The pyenchant package
 
-        return
-
     ##
     #  Properties
     ##
@@ -345,7 +355,6 @@ class Config:
     def setLastAuthor(self, value: str) -> None:
         """Set tle last used author name."""
         self._lastAuthor = simplified(value)
-        return
 
     def setMainWinSize(self, width: int, height: int) -> None:
         """Set the size of the main window, but only if the change is
@@ -357,17 +366,14 @@ class Config:
             self.mainWinSize[0] = width
         if abs(self.mainWinSize[1] - height) > 5:
             self.mainWinSize[1] = height
-        return
 
     def setWelcomeWinSize(self, width: int, height: int) -> None:
         """Set the size of the Preferences dialog window."""
         self.welcomeWinSize = [width, height]
-        return
 
     def setPreferencesWinSize(self, width: int, height: int) -> None:
         """Set the size of the Preferences dialog window."""
         self.prefsWinSize = [width, height]
-        return
 
     def setLastPath(self, key: str, path: str | Path) -> None:
         """Set the last used path. Only the folder is saved, so if the
@@ -379,12 +385,10 @@ class Config:
                 path = path.parent
             if path.is_dir():
                 self._recentPaths.setPath(key, path)
-        return
 
     def setBackupPath(self, path: Path | str) -> None:
         """Set the current backup path."""
         self._backupPath = checkPath(path, self._backPath)
-        return
 
     def setGuiFont(self, value: QFont | str | None) -> None:
         """Update the GUI's font style from settings."""
@@ -403,9 +407,8 @@ class Config:
             else:
                 font = QFontDatabase.systemFont(QFontDatabase.SystemFont.GeneralFont)
             self.guiFont = fontMatcher(font)
-            logger.debug("GUI font set to: %s", describeFont(font))
+            logger.debug("Main font set to: %s", describeFont(font))
         QApplication.setFont(self.guiFont)
-        return
 
     def setTextFont(self, value: QFont | str | None) -> None:
         """Set the text font if it exists. If it doesn't, or is None,
@@ -431,14 +434,13 @@ class Config:
                 font = QFontDatabase.systemFont(QFontDatabase.SystemFont.GeneralFont)
             self.textFont = fontMatcher(font)
             logger.debug("Text font set to: %s", describeFont(self.textFont))
-        return
 
     ##
     #  Methods
     ##
 
     def homePath(self) -> Path:
-        """The user's home folder."""
+        """Return the user's home folder."""
         return self._homePath
 
     def dataPath(self, target: str | None = None) -> Path:
@@ -520,7 +522,6 @@ class Config:
         """Send a message to the splash screen."""
         if self._splash:
             self._splash.showStatus(message)
-        return
 
     ##
     #  Config Actions
@@ -551,11 +552,10 @@ class Config:
         self._confPath.mkdir(exist_ok=True)
         self._dataPath.mkdir(exist_ok=True)
 
-        # Also create the syntax, themes and icons folders if possible
+        # Also create the themes and icons folders if possible
         if self._dataPath.is_dir():
             (self._dataPath / "cache").mkdir(exist_ok=True)
             (self._dataPath / "icons").mkdir(exist_ok=True)
-            (self._dataPath / "syntax").mkdir(exist_ok=True)
             (self._dataPath / "themes").mkdir(exist_ok=True)
 
         self._recentPaths.loadCache()
@@ -564,8 +564,6 @@ class Config:
 
         logger.debug("Config instance initialised")
 
-        return
-
     def initLocalisation(self, nwApp: QApplication) -> None:
         """Initialise the localisation of the GUI."""
         self.splashMessage("Loading localisation ...")
@@ -593,8 +591,6 @@ class Config:
                         nwApp.installTranslator(qTrans)
                         self._qtTrans[lngFile] = qTrans
 
-        return
-
     def loadConfig(self, splash: NSplashScreen | None = None) -> bool:
         """Load preferences from file and replace default settings."""
         self._splash = splash
@@ -626,8 +622,9 @@ class Config:
         # Main
         sec = "Main"
         self.setGuiFont(conf.rdStr(sec, "font", ""))
-        self.guiTheme     = conf.rdStr(sec, "theme", self.guiTheme)
-        self.guiSyntax    = conf.rdStr(sec, "syntax", self.guiSyntax)
+        self.lightTheme   = conf.rdStr(sec, "lighttheme", self.lightTheme)
+        self.darkTheme    = conf.rdStr(sec, "darktheme", self.darkTheme)
+        self.themeMode    = conf.rdEnum(sec, "thememode", self.themeMode)
         self.iconTheme    = conf.rdStr(sec, "icons", self.iconTheme)
         self.iconColTree  = conf.rdStr(sec, "iconcoltree", self.iconColTree)
         self.iconColDocs  = conf.rdBool(sec, "iconcoldocs", self.iconColDocs)
@@ -665,6 +662,7 @@ class Config:
         self.textMargin      = conf.rdInt(sec, "margin", self.textMargin)
         self.tabWidth        = conf.rdInt(sec, "tabwidth", self.tabWidth)
         self.cursorWidth     = conf.rdInt(sec, "cursorwidth", self.cursorWidth)
+        self.lineHighlight   = conf.rdBool(sec, "linehighlight", self.lineHighlight)
         self.focusWidth      = conf.rdInt(sec, "focuswidth", self.focusWidth)
         self.hideFocusFooter = conf.rdBool(sec, "hidefocusfooter", self.hideFocusFooter)
         self.doJustify       = conf.rdBool(sec, "justify", self.doJustify)
@@ -708,6 +706,7 @@ class Config:
         self.showSessionTime = conf.rdBool(sec, "showsessiontime", self.showSessionTime)
         self.viewComments    = conf.rdBool(sec, "viewcomments", self.viewComments)
         self.viewSynopsis    = conf.rdBool(sec, "viewsynopsis", self.viewSynopsis)
+        self.viewNotes       = conf.rdBool(sec, "viewnotes", self.viewNotes)
         self.searchCase      = conf.rdBool(sec, "searchcase", self.searchCase)
         self.searchWord      = conf.rdBool(sec, "searchword", self.searchWord)
         self.searchRegEx     = conf.rdBool(sec, "searchregex", self.searchRegEx)
@@ -721,7 +720,7 @@ class Config:
         # Check Values
         # ============
 
-        self._prepareFont(self.guiFont, "GUI")
+        self._prepareFont(self.guiFont, "main")
         self._prepareFont(self.textFont, "document")
 
         # If we're using straight quotes, disable auto-replace
@@ -751,8 +750,9 @@ class Config:
 
         conf["Main"] = {
             "font":         self.guiFont.toString(),
-            "theme":        str(self.guiTheme),
-            "syntax":       str(self.guiSyntax),
+            "lighttheme":   str(self.lightTheme),
+            "darktheme":    str(self.darkTheme),
+            "thememode":    self.themeMode.name,
             "icons":        str(self.iconTheme),
             "iconcoltree":  str(self.iconColTree),
             "iconcoldocs":  str(self.iconColDocs),
@@ -790,6 +790,7 @@ class Config:
             "margin":          str(self.textMargin),
             "tabwidth":        str(self.tabWidth),
             "cursorwidth":     str(self.cursorWidth),
+            "lineHighlight":   str(self.lineHighlight),
             "focuswidth":      str(self.focusWidth),
             "hidefocusfooter": str(self.hideFocusFooter),
             "justify":         str(self.doJustify),
@@ -833,6 +834,7 @@ class Config:
             "showsessiontime": str(self.showSessionTime),
             "viewcomments":    str(self.viewComments),
             "viewsynopsis":    str(self.viewSynopsis),
+            "viewnotes":       str(self.viewNotes),
             "searchcase":      str(self.searchCase),
             "searchword":      str(self.searchWord),
             "searchregex":     str(self.searchRegEx),
@@ -862,7 +864,6 @@ class Config:
     def finishStartup(self) -> None:
         """Call after startup is complete."""
         self._splash = None
-        return
 
     ##
     #  Internal Functions
@@ -884,7 +885,6 @@ class Config:
         else:
             self.hasEnchant = True
             logger.debug("Checking package 'pyenchant': OK")
-        return
 
     def _prepareFont(self, font: QFont, kind: str) -> None:
         """Check Unicode availability in font. This also initialises any
@@ -895,16 +895,15 @@ class Config:
         for char in nwUnicode.UI_SYMBOLS:
             if not metrics.inFont(char):  # type: ignore
                 logger.warning("No glyph U+%04x in font", ord(char))  # pragma: no cover
-        return
 
 
 class RecentProjects:
+    """A record of recently opened projects."""
 
     def __init__(self, config: Config) -> None:
         self._conf = config
         self._data: dict[str, dict[str, str | int]] = {}
         self._map: dict[str, str] = {}
-        return
 
     def loadCache(self) -> bool:
         """Load the cache file for recent projects."""
@@ -966,14 +965,12 @@ class RecentProjects:
             self.saveCache()
         except Exception:
             pass
-        return
 
     def remove(self, path: str | Path) -> None:
         """Try to remove a path from the recent projects cache."""
         if self._data.pop(str(path), None) is not None:
             logger.debug("Removed recent: %s", path)
             self.saveCache()
-        return
 
     def _setEntry(
         self, puuid: str, path: str, title: str, words: int, chars: int, saved: int
@@ -988,24 +985,22 @@ class RecentProjects:
         }
         if puuid:
             self._map[puuid] = path
-        return
 
 
 class RecentPaths:
+    """A record of recently used file paths."""
 
     KEYS: Final[list[str]] = ["default", "project", "import", "outline", "stats"]
 
     def __init__(self, config: Config) -> None:
         self._conf = config
         self._data = {}
-        return
 
     def setPath(self, key: str, path: Path | str) -> None:
         """Set a path for a given key, and save the cache."""
         if key in self.KEYS:
             self._data[key] = str(path)
         self.saveCache()
-        return
 
     def getPath(self, key: str) -> str | None:
         """Get a path for a given key, or return None."""

novelwriter/constants.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 from typing import Final
@@ -28,21 +28,23 @@ from typing import Final
 from PyQt6.QtCore import QT_TRANSLATE_NOOP, QCoreApplication
 
 from novelwriter.enum import (
-    nwBuildFmt, nwComment, nwItemClass, nwItemLayout, nwOutline, nwStatusShape
+    nwBuildFmt, nwComment, nwItemClass, nwItemLayout, nwOutline, nwStatusShape,
+    nwTheme
 )
 
 
 def trConst(text: str) -> str:
-    """Wrapper function for locally translating constants."""
+    """Translate a constant."""
     return QCoreApplication.translate("Constant", text)
 
 
 def trStats(text: str) -> str:
-    """Wrapper function for locally translating stats constants."""
+    """Translate a stats constants."""
     return QCoreApplication.translate("Stats", text)
 
 
 class nwConst:
+    """Various Constants."""
 
     # Date and Time Formats
     FMT_TSTAMP = "%Y-%m-%d %H:%M:%S"  # Default format
@@ -69,6 +71,7 @@ class nwConst:
 
 
 class nwRegEx:
+    """Common RegExes."""
 
     URL    = r"https?://(?:www\.|(?!www))[\w/()@:%_\+-.~#?&=]+"
     WORDS  = r"\b[^\s\-\+\/–—\[\]:]+\b"
@@ -76,11 +79,13 @@ 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):)(.+?)(?<!\\)(\])"
 
 
 class nwShortcode:
+    """Document ShortCodes."""
 
     BOLD_O   = "[b]"
     BOLD_C   = "[/b]"
@@ -110,6 +115,7 @@ class nwShortcode:
 
 
 class nwStyles:
+    """Style Settings for Headings."""
 
     H_VALID = ("H0", "H1", "H2", "H3", "H4")
     H_LEVEL: Final[dict[str, int]] = {"H0": 0, "H1": 1, "H2": 2, "H3": 3, "H4": 4}
@@ -141,6 +147,7 @@ class nwStyles:
 
 
 class nwFiles:
+    """novelWriter Files."""
 
     # Config Files
     CONF_FILE   = "novelwriter.conf"
@@ -161,6 +168,7 @@ class nwFiles:
 
 
 class nwKeyWords:
+    """Meta Data KeyWord Constants."""
 
     TAG_KEY     = "@tag"
     POV_KEY     = "@pov"
@@ -208,6 +216,7 @@ class nwKeyWords:
 
 
 class nwLists:
+    """Various Lists."""
 
     USER_CLASSES: Final[list[nwItemClass]] = [
         nwItemClass.CHARACTER,
@@ -221,6 +230,7 @@ class nwLists:
 
 
 class nwStats:
+    """Text Statistics."""
 
     CHARS        = "allChars"
     CHARS_TEXT   = "textChars"
@@ -244,6 +254,7 @@ class nwStats:
 
 
 class nwLabels:
+    """Various Common GUI Labels."""
 
     CLASS_NAME: Final[dict[nwItemClass, str]] = {
         nwItemClass.NO_CLASS:  QT_TRANSLATE_NOOP("Constant", "None"),
@@ -446,20 +457,31 @@ class nwLabels:
         "Custom": (-1.0, -1.0),
     }
     THEME_COLORS: Final[dict[str, str]] = {
-        "theme":   QT_TRANSLATE_NOOP("Constant", "Theme Colours"),
         "default": QT_TRANSLATE_NOOP("Constant", "Foreground Colour"),
+        "base":    QT_TRANSLATE_NOOP("Constant", "Background Colour"),
         "faded":   QT_TRANSLATE_NOOP("Constant", "Faded Colour"),
         "red":     QT_TRANSLATE_NOOP("Constant", "Red"),
         "orange":  QT_TRANSLATE_NOOP("Constant", "Orange"),
         "yellow":  QT_TRANSLATE_NOOP("Constant", "Yellow"),
         "green":   QT_TRANSLATE_NOOP("Constant", "Green"),
-        "aqua":    QT_TRANSLATE_NOOP("Constant", "Aqua"),
+        "cyan":    QT_TRANSLATE_NOOP("Constant", "Cyan"),
         "blue":    QT_TRANSLATE_NOOP("Constant", "Blue"),
         "purple":  QT_TRANSLATE_NOOP("Constant", "Purple"),
     }
+    THEME_MODE_ICON: Final[dict[nwTheme, str]] = {
+        nwTheme.AUTO:  "theme_auto",
+        nwTheme.LIGHT: "theme_light",
+        nwTheme.DARK:  "theme_dark",
+    }
+    THEME_MODE_LABEL: Final[dict[nwTheme, str]] = {
+        nwTheme.AUTO:  QT_TRANSLATE_NOOP("Constant", "System Theme"),
+        nwTheme.LIGHT: QT_TRANSLATE_NOOP("Constant", "Light Theme"),
+        nwTheme.DARK:  QT_TRANSLATE_NOOP("Constant", "Dark Theme"),
+    }
 
 
 class nwHeadFmt:
+    """Manuscript Header Formats."""
 
     BR         = "{BR}"
     TITLE      = "{Title}"
@@ -486,8 +508,10 @@ class nwHeadFmt:
 
 class nwQuotes:
     """Allowed quotation marks.
+
     Source: https://en.wikipedia.org/wiki/Quotation_mark
     """
+
     SYMBOLS: Final[dict[str, str]] = {
         "\u0027": QT_TRANSLATE_NOOP("Constant", "Straight single quotation mark"),
         "\u0022": QT_TRANSLATE_NOOP("Constant", "Straight double quotation mark"),
@@ -529,6 +553,7 @@ class nwQuotes:
 
 class nwUnicode:
     """Supported unicode character constants and their HTML equivalents."""
+
     # Unicode Constants
     # =================
 
@@ -660,6 +685,7 @@ class nwUnicode:
 
 
 class nwHtmlUnicode:
+    """Unicode to HTML Map."""
 
     U_TO_H: Final[dict[str, str]] = {
         # Quotes