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

novelwriter/constants.py

@@ -23,6 +23,8 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
+import re
+
 from PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP
 
 from novelwriter.enum import nwBuildFmt, nwItemClass, nwItemLayout, nwOutline
@@ -40,10 +42,6 @@ class nwConst:
     FMT_FSTAMP = "%Y-%m-%d %H.%M.%S"  # FileName safe format
     FMT_DSTAMP = "%Y-%m-%d"           # Date only format
 
-    # Various Hard Limits
-    MAX_DOCSIZE   = 5000000   # Maximum size of a single document
-    MAX_BUILDSIZE = 10000000  # Maximum size of a project build
-
     # URLs
     URL_WEB     = "https://novelwriter.io"
     URL_DOCS    = "https://docs.novelwriter.io"
@@ -52,6 +50,9 @@ class nwConst:
     URL_HELP    = "https://github.com/vkbo/novelWriter/discussions"
     URL_RELEASE = "https://github.com/vkbo/novelWriter/releases/latest"
 
+    # Requests
+    USER_AGENT = "Mozilla/5.0 (compatible; novelWriter (Python))"
+
     # Gui Settings
     STATUS_MSG_TIMEOUT = 15000  # milliseconds
 
@@ -63,10 +64,33 @@ 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_SC = r"(?i)(?<!\\)(\[[\/\!]?(?:i|b|s|u|sup|sub)\])"
+    FMT_SV = r"(?<!\\)(\[(?i)(?:fn|footnote):)(.+?)(?<!\\)(\])"
+
+    # Pre-Compiled RegEx
+    RX_SC = re.compile(FMT_SC)
 
 # END Class nwRegEx
 
 
+class nwShortcode:
+
+    BOLD_O   = "[b]"
+    BOLD_C   = "[/b]"
+    ITALIC_O = "[i]"
+    ITALIC_C = "[/i]"
+    STRIKE_O = "[s]"
+    STRIKE_C = "[/s]"
+    ULINE_O  = "[u]"
+    ULINE_C  = "[/u]"
+    SUP_O    = "[sup]"
+    SUP_C    = "[/sup]"
+    SUB_O    = "[sub]"
+    SUB_C    = "[/sub]"
+
+# END Class nwShortcode
+
+
 class nwHeaders:
 
     H_VALID = ("H0", "H1", "H2", "H3", "H4")
@@ -132,6 +156,21 @@ class nwKeyWords:
 # END Class nwKeyWords
 
 
+class nwLists:
+
+    USER_CLASSES = [
+        nwItemClass.CHARACTER,
+        nwItemClass.PLOT,
+        nwItemClass.WORLD,
+        nwItemClass.TIMELINE,
+        nwItemClass.OBJECT,
+        nwItemClass.ENTITY,
+        nwItemClass.CUSTOM,
+    ]
+
+# END Class nwLists
+
+
 class nwLabels:
 
     CLASS_NAME = {
@@ -200,8 +239,8 @@ class nwLabels:
         nwOutline.FOCUS:  QT_TRANSLATE_NOOP("Constant", "Focus"),
         nwOutline.CHAR:   KEY_NAME[nwKeyWords.CHAR_KEY],
         nwOutline.PLOT:   KEY_NAME[nwKeyWords.PLOT_KEY],
-        nwOutline.TIME:   KEY_NAME[nwKeyWords.TIME_KEY],
         nwOutline.WORLD:  KEY_NAME[nwKeyWords.WORLD_KEY],
+        nwOutline.TIME:   KEY_NAME[nwKeyWords.TIME_KEY],
         nwOutline.OBJECT: KEY_NAME[nwKeyWords.OBJECT_KEY],
         nwOutline.ENTITY: KEY_NAME[nwKeyWords.ENTITY_KEY],
         nwOutline.CUSTOM: KEY_NAME[nwKeyWords.CUSTOM_KEY],
@@ -306,8 +345,7 @@ class nwQuotes:
 
 
 class nwUnicode:
-    """Supported unicode character constants and their HTML equivalents.
-    """
+    """Supported unicode character constants and their HTML equivalents."""
     # Unicode Constants
     # =================
 

novelwriter/core/buildsettings.py

@@ -64,7 +64,6 @@ SETTINGS_TEMPLATE = {
     "text.includeKeywords":   (bool, False),
     "text.includeBodyText":   (bool, True),
     "text.addNoteHeadings":   (bool, True),
-    "format.buildLang":       (str, "en_GB"),
     "format.textFont":        (str, CONFIG.textFont),
     "format.textSize":        (int, 12),
     "format.lineHeight":      (float, 1.15, 0.75, 3.0),
@@ -107,7 +106,6 @@ SETTINGS_LABELS = {
     "text.addNoteHeadings":   QT_TRANSLATE_NOOP("Builds", "Add Titles for Notes"),
 
     "format.grpFormat":       QT_TRANSLATE_NOOP("Builds", "Text Format"),
-    "format.buildLang":       QT_TRANSLATE_NOOP("Builds", "Language"),
     "format.textFont":        QT_TRANSLATE_NOOP("Builds", "Font Family"),
     "format.textSize":        QT_TRANSLATE_NOOP("Builds", "Font Size"),
     "format.lineHeight":      QT_TRANSLATE_NOOP("Builds", "Line Height"),
@@ -158,6 +156,7 @@ class BuildSettings:
         self._uuid = str(uuid.uuid4())
         self._path = Path.home()
         self._build = ""
+        self._order = 0
         self._format = nwBuildFmt.ODT
         self._skipRoot = set()
         self._excluded = set()
@@ -166,20 +165,32 @@ class BuildSettings:
         self._changed = False
         return
 
+    @classmethod
+    def fromDict(cls, data: dict) -> BuildSettings:
+        """Create a build settings object from a dict."""
+        cls = BuildSettings()
+        cls.unpack(data)
+        return cls
+
     ##
     #  Properties
     ##
 
     @property
     def name(self) -> str:
-        """The build name."""
+        """Return the build name."""
         return self._name
 
     @property
     def buildID(self) -> str:
-        """The build ID as a UUID."""
+        """Return the build ID as a UUID."""
         return self._uuid
 
+    @property
+    def order(self) -> int:
+        """Return the build order."""
+        return self._order
+
     @property
     def lastPath(self) -> Path:
         """The last used build path."""
@@ -253,6 +264,12 @@ class BuildSettings:
             self._uuid = value
         return
 
+    def setOrder(self, value: int) -> None:
+        """Set the build order."""
+        if isinstance(value, int):
+            self._order = value
+        return
+
     def setLastPath(self, path: Path | str | None) -> None:
         """Set the last used build path."""
         if isinstance(path, str):
@@ -332,7 +349,7 @@ class BuildSettings:
     def buildItemFilter(
         self, project: NWProject, withRoots: bool = False
     ) -> dict[str, tuple[bool, FilterMode]]:
-        """Return a dictionary of item handles with filter decissions
+        """Return a dictionary of item handles with filter decisions
         applied.
         """
         result: dict[str, tuple[bool, FilterMode]] = {}
@@ -400,6 +417,7 @@ class BuildSettings:
             "uuid": self._uuid,
             "path": str(self._path),
             "build": self._build,
+            "order": self._order,
             "format": self._format.name,
             "settings": self._settings.copy(),
             "content": {
@@ -411,14 +429,15 @@ class BuildSettings:
 
     def unpack(self, data: dict) -> None:
         """Unpack a dictionary and populate the class."""
+        content = data.get("content", {})
         settings = data.get("settings", {})
-        content  = data.get("content", {})
         included = content.get("included", [])
         excluded = content.get("excluded", [])
         skipRoot = content.get("skipRoot", [])
 
         self.setName(data.get("name", ""))
         self.setBuildID(data.get("uuid", ""))
+        self.setOrder(data.get("order", 0))
         self.setLastPath(data.get("path", None))
         self.setLastBuildName(data.get("build", ""))
 
@@ -455,9 +474,9 @@ class BuildCollection:
 
     def __init__(self, project: NWProject) -> None:
         self._project = project
-        self._builds = {}
         self._lastBuild = ""
         self._defaultBuild = ""
+        self._builds: dict[str, BuildSettings] = {}
         self._loadCollection()
         return
 
@@ -485,21 +504,19 @@ class BuildCollection:
 
     def getBuild(self, buildID: str) -> BuildSettings | None:
         """Get a specific build settings object."""
-        if buildID not in self._builds:
-            return None
-        build = BuildSettings()
-        build.unpack(self._builds[buildID])
-        return build
+        return self._builds.get(buildID, None)
 
     ##
     #  Setters
     ##
 
-    def setLastBuild(self, buildID: str) -> None:
+    def setBuildsState(self, lastBuild: str, order: list[str]) -> None:
         """Set the last active build id."""
-        if buildID != self._lastBuild:
-            self._lastBuild = buildID
-            self._saveCollection()
+        for i, key in enumerate(order):
+            if build := self._builds.get(key):
+                build.setOrder(i)
+        self._lastBuild = lastBuild
+        self._saveCollection()
         return
 
     def setDefaultBuild(self, buildID: str) -> None:
@@ -512,8 +529,7 @@ class BuildCollection:
     def setBuild(self, build: BuildSettings) -> None:
         """Set build settings data in the collection."""
         if isinstance(build, BuildSettings):
-            buildID = build.buildID
-            self._builds[buildID] = build.pack()
+            self._builds[build.buildID] = build
             self._saveCollection()
         return
 
@@ -522,15 +538,15 @@ class BuildCollection:
     ##
 
     def removeBuild(self, buildID: str) -> None:
-        """Remove the a build from the collection."""
+        """Remove a build from the collection."""
         self._builds.pop(buildID, None)
         self._saveCollection()
         return
 
     def builds(self) -> Iterable[tuple[str, str]]:
         """Iterate over all available builds."""
-        for buildID in self._builds:
-            yield buildID, self._builds[buildID].get("name", "")
+        for buildID, build in sorted(self._builds.items(), key=lambda x: x[1].order):
+            yield buildID, build.name
         return
 
     ##
@@ -569,7 +585,7 @@ class BuildCollection:
             elif key == "defaultBuild":
                 self._defaultBuild = str(entry)
             elif isinstance(entry, dict):
-                self._builds[key] = entry
+                self._builds[key] = BuildSettings.fromDict(entry)
 
         return True
 
@@ -581,11 +597,11 @@ class BuildCollection:
 
         logger.debug("Saving builds file")
         try:
-            data = {
+            data: dict[str, str | dict] = {
                 "lastBuild": self._lastBuild,
                 "defaultBuild": self._defaultBuild,
             }
-            data.update(self._builds)
+            data.update({k: b.pack() for k, b in self._builds.items()})
             with open(buildsFile, mode="w+", encoding="utf-8") as outFile:
                 outFile.write(jsonEncode({"novelWriter.builds": data}, nmax=4))
         except Exception:

novelwriter/core/coretools.py

@@ -353,11 +353,13 @@ class ProjectBuilder:
         projName = data.get("projName", lblNewProject)
         projTitle = data.get("projTitle", lblNewProject)
         projAuthor = data.get("projAuthor", "")
+        projLang = data.get("projLang", "en_GB")
 
         project.data.setUuid(None)
         project.data.setName(projName)
         project.data.setTitle(projTitle)
         project.data.setAuthor(projAuthor)
+        project.data.setLanguage(projLang)
         project.setDefaultStatusImport()
         project.session.startSession()
 
@@ -404,6 +406,7 @@ class ProjectBuilder:
 
             chSynop = self.tr("Summary of the chapter.")
             scSynop = self.tr("Summary of the scene.")
+            bfNote = self.tr("A short description.")
 
             # Create chapters
             if numChapters > 0:
@@ -444,7 +447,11 @@ class ProjectBuilder:
                         aHandle = project.newFile(noteTitles[newRoot], rHandle)
                         ntTag = simplified(noteTitles[newRoot]).replace(" ", "")
                         aDoc = project.storage.getDocument(aHandle)
-                        aDoc.writeDocument(f"# {noteTitles[newRoot]}\n\n@tag: {ntTag}\n\n")
+                        aDoc.writeDocument(
+                            f"# {noteTitles[newRoot]}\n\n"
+                            f"@tag: {ntTag}\n\n"
+                            f"% Short: {bfNote}\n\n"
+                        )
 
             # Also add the archive and trash folders
             project.newRoot(nwItemClass.ARCHIVE)

novelwriter/core/docbuild.py

@@ -184,7 +184,7 @@ class NWBuildDocument:
         filtered = self._setupBuild(makeObj)
 
         if extendedMd:
-            makeObj.setGitHubMarkdown()
+            makeObj.setExtendedMarkdown()
         else:
             makeObj.setStandardMarkdown()
 
@@ -248,13 +248,9 @@ class NWBuildDocument:
     def _setupBuild(self, bldObj: Tokenizer) -> dict:
         """Configure the build object."""
         # Get Settings
-        buildLang = self._build.getStr("format.buildLang")
         textFont  = self._build.getStr("format.textFont")
         textSize  = self._build.getInt("format.textSize")
 
-        # The language lookup dict is reloaded if needed
-        self._project.setProjectLang(buildLang)
-
         fontFamily = textFont or CONFIG.textFont
         bldFont = QFont(fontFamily, textSize)
         fontInfo = QFontInfo(bldFont)
@@ -287,7 +283,7 @@ class NWBuildDocument:
 
         if isinstance(bldObj, ToOdt):
             bldObj.setColourHeaders(self._build.getBool("odt.addColours"))
-            bldObj.setLanguage(buildLang)
+            bldObj.setLanguage(self._project.data.language)
 
             scale = nwLabels.UNIT_SCALE.get(self._build.getStr("format.pageUnit"), 1.0)
             pW, pH = nwLabels.PAPER_SIZE.get(self._build.getStr("format.pageSize"), (-1.0, -1.0))