novelWriter 2.2b1__py3-none-any.whl → 2.2.1__py3-none-any.whl

novelwriter/core/item.py

@@ -3,10 +3,10 @@ novelWriter – Project Item Class
 ================================
 
 File History:
-Created: 2018-10-27 [0.0.1]
+Created: 2018-10-27 [0.0.1] NWItem
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/core/options.py

@@ -3,11 +3,11 @@ novelWriter – Project Options Cache
 ===================================
 
 File History:
-Created:   2019-10-21 [0.3.1]
-Rewritten: 2020-02-19 [0.4.5]
+Created:   2019-10-21 [0.3.1] OptionState
+Rewritten: 2020-02-19 [0.4.5] OptionState
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -69,6 +69,9 @@ VALID_MAP = {
     "GuiManuscriptBuild": {
         "winWidth", "winHeight", "fmtWidth", "sumWidth",
     },
+    "GuiDocViewerPanel": {
+        "colWidths",
+    }
 }
 
 

novelwriter/core/project.py

@@ -3,10 +3,10 @@ novelWriter – Project Wrapper
 =============================
 
 File History:
-Created: 2018-09-29 [0.0.1]
+Created: 2018-09-29 [0.0.1] NWProject
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -45,7 +45,7 @@ from novelwriter.core.sessions import NWSessionLog
 from novelwriter.core.projectxml import ProjectXMLReader, ProjectXMLWriter, XMLReadState
 from novelwriter.core.projectdata import NWProjectData
 from novelwriter.common import (
-    checkStringNone, formatInt, formatTimeStamp, hexToInt, makeFileNameSafe, minmax
+    checkStringNone, formatInt, formatTimeStamp, getFileSize, hexToInt, makeFileNameSafe, minmax
 )
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -80,7 +80,7 @@ class NWProject:
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NWProject")
         return
 
@@ -420,7 +420,7 @@ class NWProject:
         timeStamp = formatTimeStamp(time(), fileSafe=True)
         archName = baseDir / f"{cleanName} {timeStamp}.zip"
         if self._storage.zipIt(archName, compression=2):
-            size = formatInt(archName.stat().st_size)
+            size = formatInt(getFileSize(archName))
             if doNotify:
                 SHARED.info(
                     self.tr("Created a backup of your project of size {0}B.").format(size),

novelwriter/core/projectdata.py

@@ -3,10 +3,10 @@ novelWriter – Project Data Class
 ================================
 
 File History:
-Created: 2022-10-30 [2.0rc2]
+Created: 2022-10-30 [2.0rc2] NWProjectData
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -170,7 +170,7 @@ class NWProjectData:
 
     @property
     def autoReplace(self) -> dict[str, str]:
-        """Return the autoreplace dictionary."""
+        """Return the auto-replace dictionary."""
         return self._autoReplace
 
     @property

novelwriter/core/projectxml.py

@@ -8,7 +8,7 @@ Created: 2022-09-28 [2.0rc2] ProjectXMLReader
 Created: 2022-10-31 [2.0rc2] ProjectXMLWriter
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/core/sessions.py

@@ -3,10 +3,10 @@ novelWriter – Project Session Log Class
 =======================================
 
 File History:
-Created:   2023-06-11 [2.1b1]
+Created: 2023-06-11 [2.1b1] NWSessionLog
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/core/spellcheck.py

@@ -3,10 +3,11 @@ novelWriter – Spell Check Classes
 =================================
 
 File History:
-Created: 2019-06-11 [0.1.5]
+Created: 2019-06-11 [0.1.5] NWSpellEnchant
+Created: 2023-06-13 [2.1b1] UserDictionary
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -56,7 +57,7 @@ class NWSpellEnchant:
         logger.debug("Ready: NWSpellEnchant")
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NWSpellEnchant")
         return
 

novelwriter/core/status.py

@@ -3,11 +3,11 @@ novelWriter – Project Item Status Class
 =======================================
 
 File History:
-Created:   2019-05-19 [0.1.3]
-Rewritten: 2022-04-05 [2.0b1]
+Created:   2019-05-19 [0.1.3] NWStatus
+Rewritten: 2022-04-05 [2.0b1] NWStatus
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/core/storage.py

@@ -6,7 +6,7 @@ File History:
 Created: 2022-11-01 [2.0rc2] NWStorage
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/core/tohtml.py

@@ -3,10 +3,10 @@ novelWriter – HTML Text Converter
 =================================
 
 File History:
-Created: 2019-05-07 [0.0.1]
+Created: 2019-05-07 [0.0.1] ToHtml
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -287,7 +287,10 @@ class ToHtml(Tokenizer):
                 para.append(stripEscape(tTemp.rstrip()))
 
             elif tType == self.T_SYNOPSIS and self._doSynopsis:
-                lines.append(self._formatSynopsis(tText))
+                lines.append(self._formatSynopsis(tText, True))
+
+            elif tType == self.T_SHORT and self._doSynopsis:
+                lines.append(self._formatSynopsis(tText, False))
 
             elif tType == self.T_COMMENT and self._doComments:
                 lines.append(self._formatComments(tText))
@@ -454,9 +457,12 @@ class ToHtml(Tokenizer):
     #  Internal Functions
     ##
 
-    def _formatSynopsis(self, text: str) -> str:
+    def _formatSynopsis(self, text: str, synopsis: bool) -> str:
         """Apply HTML formatting to synopsis."""
-        sSynop = self._localLookup("Synopsis")
+        if synopsis:
+            sSynop = self._localLookup("Synopsis")
+        else:
+            sSynop = self._localLookup("Short Description")
         if self._genMode == self.M_PREVIEW:
             return f"<p class='comment'><span class='synopsis'>{sSynop}:</span> {text}</p>\n"
         else:

novelwriter/core/tokenizer.py

@@ -7,7 +7,7 @@ Created: 2019-05-05 [0.0.1] Tokenizer
 Created: 2023-05-23 [2.1b1] HeadingFormatter
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -34,8 +34,9 @@ from pathlib import Path
 from functools import partial
 
 from PyQt5.QtCore import QCoreApplication, QRegularExpression
+from novelwriter.core.index import processComment
 
-from novelwriter.enum import nwItemLayout
+from novelwriter.enum import nwComment, nwItemLayout
 from novelwriter.common import formatTimeStamp, numberToRoman, checkInt
 from novelwriter.constants import nwHeadFmt, nwRegEx, nwShortcode, nwUnicode
 from novelwriter.core.project import NWProject
@@ -79,17 +80,18 @@ class Tokenizer(ABC):
     # Block Type
     T_EMPTY    = 1   # Empty line (new paragraph)
     T_SYNOPSIS = 2   # Synopsis comment
-    T_COMMENT  = 3   # Comment line
-    T_KEYWORD  = 4   # Command line
-    T_TITLE    = 5   # Title
-    T_UNNUM    = 6   # Unnumbered
-    T_HEAD1    = 7   # Header 1
-    T_HEAD2    = 8   # Header 2
-    T_HEAD3    = 9   # Header 3
-    T_HEAD4    = 10  # Header 4
-    T_TEXT     = 11  # Text line
-    T_SEP      = 12  # Scene separator
-    T_SKIP     = 13  # Paragraph break
+    T_SHORT    = 3   # Short description comment
+    T_COMMENT  = 4   # Comment line
+    T_KEYWORD  = 5   # Command line
+    T_TITLE    = 6   # Title
+    T_UNNUM    = 7   # Unnumbered
+    T_HEAD1    = 8   # Header 1
+    T_HEAD2    = 9   # Header 2
+    T_HEAD3    = 10   # Header 3
+    T_HEAD4    = 11  # Header 4
+    T_TEXT     = 12  # Text line
+    T_SEP      = 13  # Scene separator
+    T_SKIP     = 14  # Paragraph break
 
     # Block Style
     A_NONE     = 0x0000  # No special style
@@ -216,7 +218,7 @@ class Tokenizer(ABC):
         return
 
     def setChapterFormat(self, hFormat: str) -> None:
-        """Set the chapert format pattern."""
+        """Set the chapter format pattern."""
         self._fmtChapter = hFormat.strip()
         return
 
@@ -435,8 +437,8 @@ class Tokenizer(ABC):
             if aLine[0] == "[":
                 # Parse special formatting line
                 # This must be a separate if statement, as it may not
-                # reach a continue statement and must thefore proceed to
-                # check other formats.
+                # reach a continue statement and must therefore proceed
+                # to check other formats.
 
                 if sLine in ("[newpage]", "[new page]"):
                     breakNext = True
@@ -461,17 +463,22 @@ class Tokenizer(ABC):
                     continue
 
             if aLine[0] == "%":
-                cLine = aLine[1:].lstrip()
-                synTag = cLine[:9].lower()
-                if synTag == "synopsis:":
+                cStyle, cText, _ = processComment(aLine)
+                if cStyle == nwComment.SYNOPSIS:
                     self._tokens.append((
-                        self.T_SYNOPSIS, nHead, cLine[9:].strip(), None, sAlign
+                        self.T_SYNOPSIS, nHead, cText, None, sAlign
+                    ))
+                    if self._doSynopsis and self._keepMarkdown:
+                        tmpMarkdown.append("%s\n" % aLine)
+                elif cStyle == nwComment.SHORT:
+                    self._tokens.append((
+                        self.T_SHORT, nHead, cText, None, sAlign
                     ))
                     if self._doSynopsis and self._keepMarkdown:
                         tmpMarkdown.append("%s\n" % aLine)
                 else:
                     self._tokens.append((
-                        self.T_COMMENT, nHead, aLine[1:].strip(), None, sAlign
+                        self.T_COMMENT, nHead, cText, None, sAlign
                     ))
                     if self._doComments and self._keepMarkdown:
                         tmpMarkdown.append("%s\n" % aLine)

novelwriter/core/tomd.py

@@ -3,10 +3,10 @@ novelWriter – Markdown Text Converter
 =====================================
 
 File History:
-Created: 2021-02-06 [1.2b1]
+Created: 2021-02-06 [1.2b1] ToMarkdown
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -170,6 +170,10 @@ class ToMarkdown(Tokenizer):
                 label = self._localLookup("Synopsis")
                 lines.append(f"**{label}:** {tText}\n\n")
 
+            elif tType == self.T_SHORT and self._doSynopsis:
+                label = self._localLookup("Short Description")
+                lines.append(f"**{label}:** {tText}\n\n")
+
             elif tType == self.T_COMMENT and self._doComments:
                 label = self._localLookup("Comment")
                 lines.append(f"**{label}:** {tText}\n\n")

novelwriter/core/toodt.py

@@ -9,7 +9,7 @@ Created: 2021-01-27 [1.2b1] ODTTextStyle
 Created: 2021-08-14 [1.5b1] XMLParagraph
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -195,7 +195,7 @@ class ToOdt(Tokenizer):
     #  Setters
     ##
 
-    def setLanguage(self, language: str) -> None:
+    def setLanguage(self, language: str | None) -> None:
         """Set language for the document."""
         if language:
             langBits = language.split("_")
@@ -481,7 +481,11 @@ class ToOdt(Tokenizer):
                 pFmt.append(tFormat)
 
             elif tType == self.T_SYNOPSIS and self._doSynopsis:
-                tTemp, fTemp = self._formatSynopsis(tText)
+                tTemp, fTemp = self._formatSynopsis(tText, True)
+                self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp)
+
+            elif tType == self.T_SHORT and self._doSynopsis:
+                tTemp, fTemp = self._formatSynopsis(tText, False)
                 self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp)
 
             elif tType == self.T_COMMENT and self._doComments:
@@ -552,9 +556,12 @@ class ToOdt(Tokenizer):
     #  Internal Functions
     ##
 
-    def _formatSynopsis(self, text: str) -> tuple[str, list[tuple[int, int]]]:
+    def _formatSynopsis(self, text: str, synopsis: bool) -> tuple[str, list[tuple[int, int]]]:
         """Apply formatting to synopsis lines."""
-        name = self._localLookup("Synopsis")
+        if synopsis:
+            name = self._localLookup("Synopsis")
+        else:
+            name = self._localLookup("Short Description")
         rTxt = f"{name}: {text}"
         rFmt = [(0, self.FMT_B_B), (len(name) + 1, self.FMT_B_E)]
         return rTxt, rFmt

novelwriter/core/tree.py

@@ -3,10 +3,10 @@ novelWriter – Project Tree Class
 ================================
 
 File History:
-Created: 2020-05-07 [0.4.5]
+Created: 2020-05-07 [0.4.5] NWTree
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

novelwriter/dialogs/about.py

@@ -3,10 +3,10 @@ novelWriter – GUI About Box
 ===========================
 
 File History:
-Created: 2020-05-21 [0.5.2]
+Created: 2020-05-21 [0.5.2] GuiAbout
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -28,7 +28,7 @@ import novelwriter
 
 from datetime import datetime
 
-from PyQt5.QtGui import QCursor
+from PyQt5.QtGui import QCloseEvent, QCursor
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
     qApp, QDialog, QDialogButtonBox, QHBoxLayout, QLabel, QTabWidget,
@@ -44,7 +44,7 @@ logger = logging.getLogger(__name__)
 
 class GuiAbout(QDialog):
 
-    def __init__(self, parent: QWidget):
+    def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
         logger.debug("Create: GuiAbout")
@@ -101,7 +101,7 @@ class GuiAbout(QDialog):
 
         # OK Button
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok)
-        self.buttonBox.accepted.connect(self._doClose)
+        self.buttonBox.accepted.connect(self.close)
 
         self.outerBox.addLayout(self.innerBox)
         self.outerBox.addWidget(self.buttonBox)
@@ -111,13 +111,12 @@ class GuiAbout(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiAbout")
         return
 
-    def populateGUI(self):
-        """Populate tabs with text.
-        """
+    def populateGUI(self) -> None:
+        """Populate tabs with text."""
         qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
         self._setStyleSheet()
         self._fillAboutPage()
@@ -127,19 +126,27 @@ class GuiAbout(QDialog):
         qApp.restoreOverrideCursor()
         return
 
-    def showReleaseNotes(self):
-        """Show the release notes.
-        """
+    def showReleaseNotes(self) -> None:
+        """Show the release notes."""
         self.tabBox.setCurrentWidget(self.pageNotes)
         return
 
+    ##
+    #  Events
+    ##
+
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
     ##
     #  Internal Functions
     ##
 
-    def _fillAboutPage(self):
-        """Generate the content for the About page.
-        """
+    def _fillAboutPage(self) -> None:
+        """Generate the content for the About page."""
         aboutMsg = (
             "<h2>{title1}</h2>"
             "<p>{copy}</p>"
@@ -181,9 +188,8 @@ class GuiAbout(QDialog):
 
         return
 
-    def _fillNotesPage(self):
-        """Load the content for the Release Notes page.
-        """
+    def _fillNotesPage(self) -> None:
+        """Load the content for the Release Notes page."""
         docPath = CONFIG.assetPath("text") / "release_notes.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -192,9 +198,8 @@ class GuiAbout(QDialog):
             self.pageNotes.setHtml("Error loading release notes text ...")
         return
 
-    def _fillCreditsPage(self):
-        """Load the content for the Credits page.
-        """
+    def _fillCreditsPage(self) -> None:
+        """Load the content for the Credits page."""
         docPath = CONFIG.assetPath("text") / "credits_en.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -203,9 +208,8 @@ class GuiAbout(QDialog):
             self.pageCredits.setHtml("Error loading credits text ...")
         return
 
-    def _fillLicensePage(self):
-        """Load the content for the Licence page.
-        """
+    def _fillLicensePage(self) -> None:
+        """Load the content for the Licence page."""
         docPath = CONFIG.assetPath("text") / "gplv3_en.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -214,9 +218,8 @@ class GuiAbout(QDialog):
             self.pageLicense.setHtml("Error loading licence text ...")
         return
 
-    def _setStyleSheet(self):
-        """Set stylesheet for all browser tabs
-        """
+    def _setStyleSheet(self) -> None:
+        """Set stylesheet for all browser tabs."""
         styleSheet = (
             "h1, h2, h3, h4 {{"
             "  color: rgb({hColR},{hColG},{hColB});"
@@ -242,8 +245,4 @@ class GuiAbout(QDialog):
 
         return
 
-    def _doClose(self):
-        self.close()
-        return
-
 # END Class GuiAbout

novelwriter/dialogs/docmerge.py

@@ -3,11 +3,11 @@ novelWriter – GUI Doc Merge Dialog
 ==================================
 
 File History:
-Created:   2020-01-23 [0.4.3]
-Rewritten: 2022-10-06 [2.0rc1]
+Created:   2020-01-23 [0.4.3]  GuiDocMerge
+Rewritten: 2022-10-06 [2.0rc1] GuiDocMerge
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -26,7 +26,8 @@ from __future__ import annotations
 
 import logging
 
-from PyQt5.QtCore import Qt, QSize
+from PyQt5.QtGui import QCloseEvent
+from PyQt5.QtCore import Qt, QSize, pyqtSlot
 from PyQt5.QtWidgets import (
     QAbstractItemView, QDialog, QDialogButtonBox, QGridLayout, QLabel,
     QListWidget, QListWidgetItem, QVBoxLayout, QWidget
@@ -108,13 +109,12 @@ class GuiDocMerge(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocMerge")
         return
 
-    def getData(self):
-        """Return the user's choices.
-        """
+    def getData(self) -> dict:
+        """Return the user's choices."""
         finalItems = []
         for i in range(self.listBox.count()):
             item = self.listBox.item(i)
@@ -127,12 +127,22 @@ class GuiDocMerge(QDialog):
         return self._data
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _resetList(self):
-        """Reset the content of the list box to its original state.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _resetList(self) -> None:
+        """Reset the content of the list box to its original state."""
         logger.debug("Resetting list box content")
         sHandle = self._data.get("sHandle", None)
         itemList = self._data.get("origItems", [])
@@ -143,9 +153,8 @@ class GuiDocMerge(QDialog):
     #  Internal Functions
     ##
 
-    def _loadContent(self, sHandle, itemList):
-        """Load content from a given list of items.
-        """
+    def _loadContent(self, sHandle: str, itemList: list[str]) -> None:
+        """Load content from a given list of items."""
         self._data = {}
         self._data["sHandle"] = sHandle
         self._data["origItems"] = itemList