novelWriter 2.2rc1__py3-none-any.whl → 2.3__py3-none-any.whl

novelwriter/config.py

@@ -7,7 +7,7 @@ Created: 2018-09-22 [0.0.1]  Config
 Created: 2022-11-09 [2.0rc2] RecentProjects
 
 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
@@ -110,8 +110,8 @@ class Config:
 
         # Size Settings
         self._mainWinSize  = [1200, 650]     # Last size of the main GUI window
+        self._welcomeSize  = [800, 550]      # Last size of the welcome window
         self._prefsWinSize = [700, 615]      # Last size of the Preferences dialog
-        self._projLoadCols = [280, 60, 160]  # Last columns widths of the Project Load dialog
         self._mainPanePos  = [300, 800]      # Last position of the main window splitter
         self._viewPanePos  = [500, 150]      # Last position of the document viewer splitter
         self._outlnPanePos = [500, 150]      # Last position of the outline panel splitter
@@ -150,9 +150,6 @@ class Config:
         self.autoScrollPos   = 30     # Start point for typewriter-like scrolling
         self.scrollPastEnd   = True   # Scroll past end of document, and centre cursor
 
-        self.wordCountTimer  = 5.0    # Interval for word count update in seconds
-        self.incNotesWCount  = True   # The status bar word count includes notes
-
         self.highlightQuotes = True   # Highlight text in quotes
         self.allowOpenSQuote = False  # Allow open-ended single quotes
         self.allowOpenDQuote = True   # Allow open-ended double quotes
@@ -160,6 +157,7 @@ class Config:
 
         self.stopWhenIdle    = True   # Stop the status bar clock when the user is idle
         self.userIdleTime    = 300    # Time of inactivity to consider user idle
+        self.incNotesWCount  = True   # The status bar word count includes notes
 
         # User-Selected Symbol Settings
         self.fmtApostrophe   = nwUnicode.U_RSQUO
@@ -225,7 +223,8 @@ class Config:
         # Other System Info
         self.hostName  = QSysInfo.machineHostName()
         self.kernelVer = QSysInfo.kernelVersion()
-        self.isDebug   = False
+        self.isDebug   = False  # True if running in debug mode
+        self.memInfo   = False  # True if displaying mem info in status bar
 
         # Packages
         self.hasEnchant = False  # The pyenchant package
@@ -249,12 +248,12 @@ class Config:
         return [int(x*self.guiScale) for x in self._mainWinSize]
 
     @property
-    def preferencesWinSize(self) -> list[int]:
-        return [int(x*self.guiScale) for x in self._prefsWinSize]
+    def welcomeWinSize(self) -> list[int]:
+        return [int(x*self.guiScale) for x in self._welcomeSize]
 
     @property
-    def projLoadColWidths(self) -> list[int]:
-        return [int(x*self.guiScale) for x in self._projLoadCols]
+    def preferencesWinSize(self) -> list[int]:
+        return [int(x*self.guiScale) for x in self._prefsWinSize]
 
     @property
     def mainPanePos(self) -> list[int]:
@@ -305,17 +304,18 @@ class Config:
             self._mainWinSize[1] = height
         return
 
+    def setWelcomeWinSize(self, width: int, height: int) -> None:
+        """Set the size of the Preferences dialog window."""
+        self._welcomeSize[0] = int(width/self.guiScale)
+        self._welcomeSize[1] = int(height/self.guiScale)
+        return
+
     def setPreferencesWinSize(self, width: int, height: int) -> None:
         """Set the size of the Preferences dialog window."""
         self._prefsWinSize[0] = int(width/self.guiScale)
         self._prefsWinSize[1] = int(height/self.guiScale)
         return
 
-    def setProjLoadColWidths(self, widths: list[int]) -> None:
-        """Set the column widths of the Load Project dialog."""
-        self._projLoadCols = [int(x/self.guiScale) for x in widths]
-        return
-
     def setMainPanePos(self, pos: list[int]) -> None:
         """Set the position of the main GUI splitter."""
         self._mainPanePos = [int(x/self.guiScale) for x in pos]
@@ -409,10 +409,10 @@ class Config:
         """Compile and return error messages from the initialisation of
         the Config class, and clear the error buffer.
         """
-        errMessage = "<br>".join(self._errData)
+        message = "<br>".join(self._errData)
         self._hasError = False
         self._errData = []
-        return errMessage
+        return message
 
     def listLanguages(self, lngSet: int) -> list[tuple[str, str]]:
         """List localisation files in the i18n folder. The default GUI
@@ -485,7 +485,6 @@ class Config:
 
         self._recentObj.loadCache()
         self._checkOptionalPackages()
-        self.isDebug = logger.getEffectiveLevel() == logging.DEBUG
 
         logger.debug("Config instance initialised")
 
@@ -545,8 +544,8 @@ class Config:
         # Sizes
         sec = "Sizes"
         self._mainWinSize  = conf.rdIntList(sec, "mainwindow", self._mainWinSize)
+        self._welcomeSize  = conf.rdIntList(sec, "welcome", self._welcomeSize)
         self._prefsWinSize = conf.rdIntList(sec, "preferences", self._prefsWinSize)
-        self._projLoadCols = conf.rdIntList(sec, "projloadcols", self._projLoadCols)
         self._mainPanePos  = conf.rdIntList(sec, "mainpane", self._mainPanePos)
         self._viewPanePos  = conf.rdIntList(sec, "viewpane", self._viewPanePos)
         self._outlnPanePos = conf.rdIntList(sec, "outlinepane", self._outlnPanePos)
@@ -590,7 +589,6 @@ class Config:
         self.showTabsNSpaces = conf.rdBool(sec, "showtabsnspaces", self.showTabsNSpaces)
         self.showLineEndings = conf.rdBool(sec, "showlineendings", self.showLineEndings)
         self.showMultiSpaces = conf.rdBool(sec, "showmultispaces", self.showMultiSpaces)
-        self.wordCountTimer  = conf.rdFlt(sec, "wordcounttimer", self.wordCountTimer)
         self.incNotesWCount  = conf.rdBool(sec, "incnoteswcount", self.incNotesWCount)
         self.showFullPath    = conf.rdBool(sec, "showfullpath", self.showFullPath)
         self.highlightQuotes = conf.rdBool(sec, "highlightquotes", self.highlightQuotes)
@@ -635,7 +633,7 @@ class Config:
         conf = NWConfigParser()
 
         conf["Meta"] = {
-            "timestamp":    formatTimeStamp(time()),
+            "timestamp": formatTimeStamp(time()),
         }
 
         conf["Main"] = {
@@ -651,12 +649,12 @@ class Config:
         }
 
         conf["Sizes"] = {
-            "mainwindow":   self._packList(self._mainWinSize),
-            "preferences":  self._packList(self._prefsWinSize),
-            "projloadcols": self._packList(self._projLoadCols),
-            "mainpane":     self._packList(self._mainPanePos),
-            "viewpane":     self._packList(self._viewPanePos),
-            "outlinepane":  self._packList(self._outlnPanePos),
+            "mainwindow":  self._packList(self._mainWinSize),
+            "welcome":     self._packList(self._welcomeSize),
+            "preferences": self._packList(self._prefsWinSize),
+            "mainpane":    self._packList(self._mainPanePos),
+            "viewpane":    self._packList(self._viewPanePos),
+            "outlinepane": self._packList(self._outlnPanePos),
         }
 
         conf["Project"] = {
@@ -697,7 +695,6 @@ class Config:
             "showtabsnspaces": str(self.showTabsNSpaces),
             "showlineendings": str(self.showLineEndings),
             "showmultispaces": str(self.showMultiSpaces),
-            "wordcounttimer":  str(self.wordCountTimer),
             "incnoteswcount":  str(self.incNotesWCount),
             "showfullpath":    str(self.showFullPath),
             "highlightquotes": str(self.highlightQuotes),
@@ -774,22 +771,20 @@ class RecentProjects:
         self._data = {}
 
         cacheFile = self._conf.dataPath(nwFiles.RECENT_FILE)
-        if not cacheFile.is_file():
-            return True
-
-        try:
-            with open(cacheFile, mode="r", encoding="utf-8") as inFile:
-                theData = json.load(inFile)
-            for projPath, theEntry in theData.items():
-                self._data[projPath] = {
-                    "title": theEntry.get("title", ""),
-                    "words": theEntry.get("words", 0),
-                    "time": theEntry.get("time", 0),
-                }
-        except Exception:
-            logger.error("Could not load recent project cache")
-            logException()
-            return False
+        if cacheFile.is_file():
+            try:
+                with open(cacheFile, mode="r", encoding="utf-8") as inFile:
+                    data = json.load(inFile)
+                for path, entry in data.items():
+                    self._data[path] = {
+                        "title": entry.get("title", ""),
+                        "words": entry.get("words", 0),
+                        "time": entry.get("time", 0),
+                    }
+            except Exception:
+                logger.error("Could not load recent project cache")
+                logException()
+                return False
 
         return True
 

novelwriter/constants.py

@@ -6,7 +6,7 @@ File History:
 Created: 2019-04-28 [0.0.1]
 
 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
@@ -43,12 +43,12 @@ class nwConst:
     FMT_DSTAMP = "%Y-%m-%d"           # Date only format
 
     # URLs
-    URL_WEB     = "https://novelwriter.io"
-    URL_DOCS    = "https://docs.novelwriter.io"
-    URL_CODE    = "https://github.com/vkbo/novelWriter"
-    URL_REPORT  = "https://github.com/vkbo/novelWriter/issues"
-    URL_HELP    = "https://github.com/vkbo/novelWriter/discussions"
-    URL_RELEASE = "https://github.com/vkbo/novelWriter/releases/latest"
+    URL_WEB      = "https://novelwriter.io"
+    URL_DOCS     = "https://docs.novelwriter.io"
+    URL_RELEASES = "https://releases.novelwriter.io"
+    URL_CODE     = "https://github.com/vkbo/novelWriter"
+    URL_REPORT   = "https://github.com/vkbo/novelWriter/issues"
+    URL_HELP     = "https://github.com/vkbo/novelWriter/discussions"
 
     # Requests
     USER_AGENT = "Mozilla/5.0 (compatible; novelWriter (Python))"
@@ -56,6 +56,9 @@ class nwConst:
     # Gui Settings
     STATUS_MSG_TIMEOUT = 15000  # milliseconds
 
+    # Dialogs
+    DLG_FINISHED = 2
+
 # END Class nwConst
 
 
@@ -107,7 +110,6 @@ class nwFiles:
 
     # Project Root Files
     PROJ_FILE   = "nwProject.nwx"
-    PROJ_BACKUP = "nwProject.bak"
     PROJ_LOCK   = "nwProject.lock"
     TOC_TXT     = "ToC.txt"
 
@@ -184,6 +186,7 @@ class nwLabels:
         nwItemClass.ENTITY:    QT_TRANSLATE_NOOP("Constant", "Entities"),
         nwItemClass.CUSTOM:    QT_TRANSLATE_NOOP("Constant", "Custom"),
         nwItemClass.ARCHIVE:   QT_TRANSLATE_NOOP("Constant", "Archive"),
+        nwItemClass.TEMPLATE:  QT_TRANSLATE_NOOP("Constant", "Templates"),
         nwItemClass.TRASH:     QT_TRANSLATE_NOOP("Constant", "Trash"),
     }
     CLASS_ICON = {
@@ -197,6 +200,7 @@ class nwLabels:
         nwItemClass.ENTITY:    "cls_entity",
         nwItemClass.CUSTOM:    "cls_custom",
         nwItemClass.ARCHIVE:   "cls_archive",
+        nwItemClass.TEMPLATE:  "cls_template",
         nwItemClass.TRASH:     "cls_trash",
     }
     LAYOUT_NAME = {
@@ -266,6 +270,13 @@ class nwLabels:
         nwBuildFmt.J_HTML: ".json",
         nwBuildFmt.J_NWD:  ".json",
     }
+    FILE_FILTERS = {
+        "*.txt": QT_TRANSLATE_NOOP("Constant", "Text files"),
+        "*.md":  QT_TRANSLATE_NOOP("Constant", "Markdown files"),
+        "*.nwd": QT_TRANSLATE_NOOP("Constant", "novelWriter files"),
+        "*.csv": QT_TRANSLATE_NOOP("Constant", "CSV files"),
+        "*":     QT_TRANSLATE_NOOP("Constant", "All files"),
+    }
     UNIT_NAME = {
         "mm": QT_TRANSLATE_NOOP("Constant", "Millimetres"),
         "cm": QT_TRANSLATE_NOOP("Constant", "Centimetres"),
@@ -298,16 +309,27 @@ class nwLabels:
 
 class nwHeadFmt:
 
-    BR      = "{BR}"
-    TITLE   = "{Title}"
-    CH_NUM  = "{Chapter}"
-    CH_WORD = "{Chapter:Word}"
-    CH_ROMU = "{Chapter:URoman}"
-    CH_ROML = "{Chapter:LRoman}"
-    SC_NUM  = "{Scene}"
-    SC_ABS  = "{Scene:Abs}"
+    BR         = "{BR}"
+    TITLE      = "{Title}"
+    CH_NUM     = "{Chapter}"
+    CH_WORD    = "{Chapter:Word}"
+    CH_ROMU    = "{Chapter:URoman}"
+    CH_ROML    = "{Chapter:LRoman}"
+    SC_NUM     = "{Scene}"
+    SC_ABS     = "{Scene:Abs}"
+    CHAR_POV   = "{Char:POV}"
+    CHAR_FOCUS = "{Char:Focus}"
+
+    PAGE_HEADERS = [
+        TITLE, CH_NUM, CH_WORD, CH_ROMU, CH_ROML, SC_NUM, SC_ABS,
+        CHAR_POV, CHAR_FOCUS
+    ]
 
-    ALL = [TITLE, CH_NUM, CH_WORD, CH_ROMU, CH_ROML, SC_NUM, SC_ABS]
+    # ODT Document Page Header
+    ODT_PROJECT = "{Project}"
+    ODT_AUTHOR = "{Author}"
+    ODT_PAGE = "{Page}"
+    ODT_AUTO = "{Project} / {Author} / {Page}"
 
 # END Class nwHeadFmt
 

novelwriter/core/buildsettings.py

@@ -7,7 +7,7 @@ Created: 2023-02-14 [2.1b1] BuildSettings
 Created: 2023-05-22 [2.1b1] BuildCollection
 
 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
@@ -29,8 +29,8 @@ import uuid
 import logging
 
 from enum import Enum
-from typing import Iterable
 from pathlib import Path
+from collections.abc import Iterable
 
 from PyQt5.QtCore import QT_TRANSLATE_NOOP, QCoreApplication
 
@@ -79,6 +79,8 @@ SETTINGS_TEMPLATE = {
     "format.leftMargin":      (float, 2.0),
     "format.rightMargin":     (float, 2.0),
     "odt.addColours":         (bool, True),
+    "odt.pageHeader":         (str, nwHeadFmt.ODT_AUTO),
+    "odt.pageCountOffset":    (int, 0),
     "html.addStyles":         (bool, True),
 }
 
@@ -125,6 +127,8 @@ SETTINGS_LABELS = {
 
     "odt":                    QT_TRANSLATE_NOOP("Builds", "Open Document (.odt)"),
     "odt.addColours":         QT_TRANSLATE_NOOP("Builds", "Add Highlight Colours"),
+    "odt.pageHeader":         QT_TRANSLATE_NOOP("Builds", "Page Header"),
+    "odt.pageCountOffset":    QT_TRANSLATE_NOOP("Builds", "Page Counter Offset"),
 
     "html":                   QT_TRANSLATE_NOOP("Builds", "HTML (.html)"),
     "html.addStyles":         QT_TRANSLATE_NOOP("Builds", "Add CSS Styles"),
@@ -235,16 +239,12 @@ class BuildSettings:
     def getInt(self, key: str) -> int:
         """Type safe value access for integers."""
         value = self._settings.get(key, SETTINGS_TEMPLATE.get(key, (None, None))[1])
-        if isinstance(value, (int, float)):
-            return int(value)
-        return 0
+        return int(value) if isinstance(value, (int, float)) else 0
 
     def getFloat(self, key: str) -> float:
         """Type safe value access for floats."""
         value = self._settings.get(key, SETTINGS_TEMPLATE.get(key, (None, None))[1])
-        if isinstance(value, (int, float)):
-            return float(value)
-        return 0.0
+        return float(value) if isinstance(value, (int, float)) else 0.0
 
     ##
     #  Setters