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

novelwriter/common.py

@@ -3,10 +3,10 @@ novelWriter – Common Functions
 ==============================
 
 File History:
-Created: 2019-05-12 [0.1]
+Created: 2019-05-12 [0.1.0]
 
 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
@@ -33,9 +33,11 @@ from typing import Any, Literal
 from pathlib import Path
 from datetime import datetime
 from configparser import ConfigParser
+from urllib.parse import urljoin
+from urllib.request import pathname2url
 
-from PyQt5.QtCore import QCoreApplication
-from PyQt5.QtWidgets import QWidget, qApp
+from PyQt5.QtGui import QDesktopServices
+from PyQt5.QtCore import QCoreApplication, QUrl
 
 from novelwriter.enum import nwItemClass, nwItemType, nwItemLayout
 from novelwriter.error import logException
@@ -44,9 +46,9 @@ from novelwriter.constants import nwConst, nwUnicode
 logger = logging.getLogger(__name__)
 
 
-# =============================================================================================== #
+##
 #  Checker Functions
-# =============================================================================================== #
+##
 
 def checkStringNone(value: Any, default: str | None) -> str | None:
     """Check if a variable is a string or a None."""
@@ -129,9 +131,9 @@ def checkPath(value: Any, default: Path) -> Path:
     return default
 
 
-# =============================================================================================== #
+##
 #  Validator Functions
-# =============================================================================================== #
+##
 
 def isHandle(value: Any) -> bool:
     """Check if a string is a valid novelWriter handle.
@@ -202,9 +204,9 @@ def checkIntTuple(value: int, valid: tuple | list | set, default: int) -> int:
     return default
 
 
-# =============================================================================================== #
+##
 #  Formatting Functions
-# =============================================================================================== #
+##
 
 def formatInt(value: int) -> str:
     """Formats an integer with k, M, G etc."""
@@ -248,9 +250,9 @@ def formatTime(t: int) -> str:
     return "ERROR"
 
 
-# =============================================================================================== #
+##
 #  String Functions
-# =============================================================================================== #
+##
 
 def simplified(text: str) -> str:
     """Take a string and strip leading and trailing whitespaces, and
@@ -369,9 +371,9 @@ def numberToRoman(value: int, toLower: bool = False) -> str:
     return roman.lower() if toLower else roman
 
 
-# =============================================================================================== #
+##
 #  Encoder Functions
-# =============================================================================================== #
+##
 
 def jsonEncode(data: dict | list | tuple, n: int = 0, nmax: int = 0) -> str:
     """Encode a dictionary, list or tuple as a json object or array, and
@@ -461,9 +463,9 @@ def xmlIndent(tree: ET.Element | ET.ElementTree) -> None:
     return
 
 
-# =============================================================================================== #
+##
 #  File and File System Functions
-# =============================================================================================== #
+##
 
 def readTextFile(path: str | Path) -> str:
     """Read the content of a text file in a robust manner."""
@@ -487,21 +489,27 @@ def makeFileNameSafe(text: str) -> str:
     return "".join(c for c in text if c.isalnum() or c in allowed)
 
 
-# =============================================================================================== #
-#  Other Functions
-# =============================================================================================== #
+def getFileSize(path: Path) -> int:
+    """Return the size of a file."""
+    try:
+        return path.stat().st_size
+    except Exception:
+        return -1
 
-def getGuiItem(objName: str) -> QWidget | None:
-    """Returns a QtWidget based on its objectName."""
-    for qWidget in qApp.topLevelWidgets():
-        if qWidget.objectName() == objName:
-            return qWidget
-    return None
+
+def openExternalPath(path: Path) -> bool:
+    """Open a path by passing it to the desktop environment."""
+    if Path(path).exists():
+        QDesktopServices.openUrl(
+            QUrl(urljoin("file:", pathname2url(str(path))))
+        )
+        return True
+    return False
 
 
-# =============================================================================================== #
+##
 #  Classes
-# =============================================================================================== #
+##
 
 class NWConfigParser(ConfigParser):
     """Common: Adapted Config Parser

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
@@ -148,6 +148,7 @@ class Config:
 
         self.autoScroll      = False  # Typewriter-like scrolling
         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
@@ -178,9 +179,9 @@ class Config:
         self.spellLanguage = "en"
 
         # State
-        self.showRefPanel    = True   # The reference panel for the viewer is visible
+        self.showViewerPanel = True   # The panel for the viewer is visible
         self.showEditToolBar = False  # The document editor toolbar visibility
-        self.useShortcodes   = False  # Use shorcodes for basic formatting
+        self.useShortcodes   = False  # Use shortcodes for basic formatting
         self.viewComments    = True   # Comments are shown in the viewer
         self.viewSynopsis    = True   # Synopsis is shown in the viewer
 
@@ -224,6 +225,8 @@ class Config:
         # Other System Info
         self.hostName  = QSysInfo.machineHostName()
         self.kernelVer = QSysInfo.kernelVersion()
+        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
@@ -391,8 +394,7 @@ class Config:
         return self._appPath / "assets"
 
     def lastPath(self) -> Path:
-        """Return the last path used by the user, but ensure it exists.
-        """
+        """Return the last path used by the user, if it exists."""
         if isinstance(self._lastPath, Path):
             if self._lastPath.is_dir():
                 return self._lastPath
@@ -400,9 +402,8 @@ class Config:
 
     def backupPath(self) -> Path:
         """Return the backup path."""
-        if isinstance(self._backupPath, Path):
-            if self._backupPath.is_dir():
-                return self._backupPath
+        if isinstance(self._backupPath, Path) and self._backupPath.is_dir():
+            return self._backupPath
         return self._backPath
 
     def errorText(self) -> str:
@@ -577,6 +578,7 @@ class Config:
         self.doReplaceDots   = conf.rdBool(sec, "repdots", self.doReplaceDots)
         self.autoScroll      = conf.rdBool(sec, "autoscroll", self.autoScroll)
         self.autoScrollPos   = conf.rdInt(sec, "autoscrollpos", self.autoScrollPos)
+        self.scrollPastEnd   = conf.rdBool(sec, "scrollpastend", self.scrollPastEnd)
         self.fmtSQuoteOpen   = conf.rdStr(sec, "fmtsquoteopen", self.fmtSQuoteOpen)
         self.fmtSQuoteClose  = conf.rdStr(sec, "fmtsquoteclose", self.fmtSQuoteClose)
         self.fmtDQuoteOpen   = conf.rdStr(sec, "fmtdquoteopen", self.fmtDQuoteOpen)
@@ -600,7 +602,7 @@ class Config:
 
         # State
         sec = "State"
-        self.showRefPanel    = conf.rdBool(sec, "showrefpanel", self.showRefPanel)
+        self.showViewerPanel = conf.rdBool(sec, "showviewerpanel", self.showViewerPanel)
         self.showEditToolBar = conf.rdBool(sec, "showedittoolbar", self.showEditToolBar)
         self.useShortcodes   = conf.rdBool(sec, "useshortcodes", self.useShortcodes)
         self.viewComments    = conf.rdBool(sec, "viewcomments", self.viewComments)
@@ -612,24 +614,6 @@ class Config:
         self.searchNextFile  = conf.rdBool(sec, "searchnextfile", self.searchNextFile)
         self.searchMatchCap  = conf.rdBool(sec, "searchmatchcap", self.searchMatchCap)
 
-        # Deprecated Settings or Locations as of 2.0
-        # ToDo: These will be loaded for a few minor releases until the users have converted them
-        self.guiFont         = conf.rdStr("Main", "guifont", self.guiFont)
-        self.guiFontSize     = conf.rdInt("Main", "guifontsize", self.guiFontSize)
-        self.guiLocale       = conf.rdStr("Main", "guilang", self.guiLocale)
-        self._backupPath     = conf.rdPath("Backup", "backuppath", self._backupPath)
-        self.backupOnClose   = conf.rdBool("Backup", "backuponclose", self.backupOnClose)
-        self.askBeforeBackup = conf.rdBool("Backup", "askbeforebackup", self.askBeforeBackup)
-        fmtSingleQuotes      = conf.rdStrList(sec, "fmtsinglequote", [])
-        fmtDoubleQuotes      = conf.rdStrList(sec, "fmtdoublequote", [])
-
-        if isinstance(fmtSingleQuotes, list) and len(fmtSingleQuotes) == 2:
-            self.fmtSQuoteOpen = fmtSingleQuotes[0]
-            self.fmtSQuoteClose = fmtSingleQuotes[1]
-        if isinstance(fmtDoubleQuotes, list) and len(fmtDoubleQuotes) == 2:
-            self.fmtDQuoteOpen = fmtDoubleQuotes[0]
-            self.fmtDQuoteClose = fmtDoubleQuotes[1]
-
         # Check Values
         # ============
 
@@ -701,6 +685,7 @@ class Config:
             "repdots":         str(self.doReplaceDots),
             "autoscroll":      str(self.autoScroll),
             "autoscrollpos":   str(self.autoScrollPos),
+            "scrollpastend":   str(self.scrollPastEnd),
             "fmtsquoteopen":   str(self.fmtSQuoteOpen),
             "fmtsquoteclose":  str(self.fmtSQuoteClose),
             "fmtdquoteopen":   str(self.fmtDQuoteOpen),
@@ -724,7 +709,7 @@ class Config:
         }
 
         conf["State"] = {
-            "showrefpanel":    str(self.showRefPanel),
+            "showviewerpanel": str(self.showViewerPanel),
             "showedittoolbar": str(self.showEditToolBar),
             "useshortcodes":   str(self.useShortcodes),
             "viewcomments":    str(self.viewComments),

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
@@ -50,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
 
@@ -153,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 = {
@@ -221,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],
@@ -327,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

@@ -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
@@ -349,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]] = {}

novelwriter/core/coretools.py

@@ -6,9 +6,10 @@ File History:
 Created: 2022-10-02 [2.0rc1] DocMerger
 Created: 2022-10-11 [2.0rc1] DocSplitter
 Created: 2022-11-03 [2.0rc2] ProjectBuilder
+Created: 2023-07-20 [2.1b1]  DocDuplicator
 
 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
@@ -406,6 +407,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:
@@ -446,7 +448,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

@@ -6,7 +6,7 @@ File History:
 Created: 2022-12-01 [2.1b1] NWBuildDocument
 
 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/document.py

@@ -6,7 +6,7 @@ File History:
 Created: 2018-09-29 [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

novelwriter/core/index.py

@@ -11,7 +11,7 @@ Created: 2022-05-29 [2.0rc1] TagsIndex
 Created: 2022-05-29 [2.0rc1] ItemIndex
 
 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
@@ -35,7 +35,8 @@ from time import time
 from typing import TYPE_CHECKING, ItemsView, Iterable, Iterator
 from pathlib import Path
 
-from novelwriter.enum import nwItemClass, nwItemType, nwItemLayout
+from novelwriter import SHARED
+from novelwriter.enum import nwComment, nwItemClass, nwItemType, nwItemLayout
 from novelwriter.error import logException
 from novelwriter.common import checkInt, isHandle, isItemClass, isTitleTag, jsonEncode
 from novelwriter.constants import nwFiles, nwKeyWords, nwRegEx, nwUnicode, nwHeaders
@@ -112,6 +113,7 @@ class NWIndex:
         self._itemIndex.clear()
         self._indexChange = 0.0
         self._rootChange = {}
+        SHARED.indexSignalProxy({"event": "clearIndex"})
         return
 
     def rebuildIndex(self) -> None:
@@ -121,16 +123,22 @@ class NWIndex:
             if nwItem.isFileType():
                 tHandle = nwItem.itemHandle
                 theDoc = self._project.storage.getDocument(tHandle)
-                self.scanText(tHandle, theDoc.readDocument() or "")
+                self.scanText(tHandle, theDoc.readDocument() or "", blockSignal=True)
         self._indexBroken = False
+        SHARED.indexSignalProxy({"event": "buildIndex"})
         return
 
     def deleteHandle(self, tHandle: str) -> None:
         """Delete all entries of a given document handle."""
         logger.debug("Removing item '%s' from the index", tHandle)
-        for tTag in self._itemIndex.allItemTags(tHandle):
+        delTags = self._itemIndex.allItemTags(tHandle)
+        for tTag in delTags:
             del self._tagsIndex[tTag]
         del self._itemIndex[tHandle]
+        SHARED.indexSignalProxy({
+            "event": "updateTags",
+            "deleted": delTags,
+        })
         return
 
     def reIndexHandle(self, tHandle: str | None) -> bool:
@@ -138,14 +146,12 @@ class NWIndex:
         moved from the archive or trash folders back into the active
         project.
         """
-        if tHandle is None or not self._project.tree.checkType(tHandle, nwItemType.FILE):
-            return False
-
-        logger.debug("Re-indexing item '%s'", tHandle)
-        theDoc = self._project.storage.getDocument(tHandle)
-        self.scanText(tHandle, theDoc.readDocument() or "")
-
-        return True
+        if tHandle and self._project.tree.checkType(tHandle, nwItemType.FILE):
+            logger.debug("Re-indexing item '%s'", tHandle)
+            theDoc = self._project.storage.getDocument(tHandle)
+            self.scanText(tHandle, theDoc.readDocument() or "")
+            return True
+        return False
 
     def indexChangedSince(self, checkTime: int | float) -> bool:
         """Check if the index has changed since a given time."""
@@ -200,6 +206,7 @@ class NWIndex:
                 self.reIndexHandle(fHandle)
 
         self._indexChange = time()
+        SHARED.indexSignalProxy({"event": "buildIndex"})
 
         logger.debug("Index loaded in %.3f ms", (time() - tStart)*1000)
 
@@ -238,7 +245,7 @@ class NWIndex:
     #  Index Building
     ##
 
-    def scanText(self, tHandle: str, text: str) -> bool:
+    def scanText(self, tHandle: str, text: str, blockSignal: bool = False) -> bool:
         """Scan a piece of text associated with a handle. This will
         update the indices accordingly. This function takes the handle
         and text as separate inputs as we want to primarily scan the
@@ -282,6 +289,11 @@ class NWIndex:
         nowTime = time()
         self._indexChange = nowTime
         self._rootChange[tItem.itemRoot] = nowTime
+        if not blockSignal:
+            SHARED.indexSignalProxy({
+                "event": "scanText",
+                "handle": tHandle,
+            })
 
         return True
 
@@ -289,7 +301,7 @@ class NWIndex:
     #  Internal Indexer Helpers
     ##
 
-    def _scanActive(self, tHandle: str, nwItem: NWItem, text: str, tags: dict) -> None:
+    def _scanActive(self, tHandle: str, nwItem: NWItem, text: str, tags: dict[str, bool]) -> None:
         """Scan an active document for meta data."""
         nTitle = 0           # Line Number of the previous title
         cTitle = TT_NONE     # Tag of the current title
@@ -326,14 +338,9 @@ class NWIndex:
 
             elif line.startswith("%"):
                 if cTitle != TT_NONE:
-                    toCheck = line[1:].lstrip()
-                    synTag = toCheck[:9].lower()
-                    tLen = len(line)
-                    cLen = len(toCheck)
-                    cOff = tLen - cLen
-                    if synTag == "synopsis:":
-                        sText = line[cOff+9:].strip()
-                        self._itemIndex.setHeadingSynopsis(tHandle, cTitle, sText)
+                    cStyle, cText, _ = processComment(line)
+                    if cStyle in (nwComment.SYNOPSIS, nwComment.SHORT):
+                        self._itemIndex.setHeadingSynopsis(tHandle, cTitle, cText)
 
         # Count words for remaining text after last heading
         if pTitle != TT_NONE:
@@ -346,9 +353,21 @@ class NWIndex:
 
         # Prune no longer used tags
         for tTag, isActive in tags.items():
-            if not isActive:
-                logger.debug("Deleting removed tag '%s'", tTag)
+            updated = []
+            deleted = []
+            if isActive:
+                logger.debug("Added/updated tag '%s'", tTag)
+                updated.append(tTag)
+            else:
+                logger.debug("Removed tag '%s'", tTag)
                 del self._tagsIndex[tTag]
+                deleted.append(tTag)
+            if updated or deleted:
+                SHARED.indexSignalProxy({
+                    "event": "updateTags",
+                    "updated": updated,
+                    "deleted": deleted,
+                })
 
         return
 
@@ -385,7 +404,7 @@ class NWIndex:
         return
 
     def _indexKeyword(self, tHandle: str, line: str, sTitle: str,
-                      itemClass: nwItemClass, tags: dict) -> None:
+                      itemClass: nwItemClass, tags: dict[str, bool]) -> None:
         """Validate and save the information about a reference to a tag
         in another file, or the setting of a tag in the file. A record
         of active tags is updated so that no longer used tags can be
@@ -532,7 +551,7 @@ class NWIndex:
         return 0
 
     def getTableOfContents(
-        self, rHandle: str, maxDepth: int, skipExcl: bool = True
+        self, rHandle: str | None, maxDepth: int, skipExcl: bool = True
     ) -> list[tuple[str, int, str, int]]:
         """Generate a table of contents up to a maximum depth."""
         tOrder = []
@@ -596,10 +615,8 @@ class NWIndex:
 
         return tRefs
 
-    def getBackReferenceList(self, tHandle: str) -> dict[str, str]:
-        """Build a list of files referring back to our file, specified
-        by tHandle.
-        """
+    def getBackReferenceList(self, tHandle: str) -> dict[str, tuple[str, IndexHeading]]:
+        """Build a dict of files referring back to our file."""
         if tHandle is None or tHandle not in self._itemIndex:
             return {}
 
@@ -611,20 +628,43 @@ class NWIndex:
         for aHandle, sTitle, hItem in self._itemIndex.iterAllHeaders():
             for aTag in hItem.references:
                 if aTag in tTags and aHandle not in tRefs:
-                    tRefs[aHandle] = sTitle
+                    tRefs[aHandle] = (sTitle, hItem)
 
         return tRefs
 
-    def getTagSource(self, tagKey: str) -> tuple[str, str]:
+    def getTagSource(self, tagKey: str) -> tuple[str | None, str]:
         """Return the source location of a given tag."""
         tHandle = self._tagsIndex.tagHandle(tagKey)
         sTitle = self._tagsIndex.tagHeading(tagKey)
         return tHandle, sTitle
 
-    def getTags(self, itemClass: nwItemClass) -> list[str]:
+    def getDocumentTags(self, tHandle: str | None) -> list[str]:
+        """Return all tags used by a specific document."""
+        return self._itemIndex.allItemTags(tHandle) if tHandle else []
+
+    def getClassTags(self, itemClass: nwItemClass) -> list[str]:
         """Return all tags based on itemClass."""
         return self._tagsIndex.filterTagNames(itemClass.name)
 
+    def getTagsData(self) -> Iterator[tuple[str, str, str, IndexItem | None, IndexHeading | None]]:
+        """Return all known tags."""
+        for tag, data in self._tagsIndex.items():
+            iItem = self._itemIndex[data.get("handle")]
+            hItem = None if iItem is None else iItem[data.get("heading")]
+            yield tag, data.get("name", ""), data.get("class", ""), iItem, hItem
+        return
+
+    def getSingleTag(self, tagKey: str) -> tuple[str, str, IndexItem | None, IndexHeading | None]:
+        """Return tag data for a specific tag."""
+        tName = self._tagsIndex.tagName(tagKey)
+        tClass = self._tagsIndex.tagClass(tagKey)
+        tHandle = self._tagsIndex.tagHandle(tagKey)
+        tHeading = self._tagsIndex.tagHeading(tagKey)
+        if tName and tClass and tHandle and tHeading:
+            iItem = self._itemIndex[tHandle]
+            return tName, tClass, iItem, None if iItem is None else iItem[tHeading]
+        return "", "", None, None
+
 # END Class NWIndex
 
 
@@ -643,7 +683,7 @@ class TagsIndex:
     __slots__ = ("_tags")
 
     def __init__(self) -> None:
-        self._tags: dict[str, dict] = {}
+        self._tags: dict[str, dict[str, str]] = {}
         return
 
     def __contains__(self, tagKey: str) -> bool:
@@ -665,6 +705,10 @@ class TagsIndex:
         self._tags = {}
         return
 
+    def items(self) -> ItemsView:
+        """Return a dictionary view of all tags."""
+        return self._tags.items()
+
     def add(self, tagKey: str, tHandle: str, sTitle: str, itemClass: nwItemClass) -> None:
         """Add a key to the index and set all values."""
         self._tags[tagKey.lower()] = {
@@ -676,7 +720,7 @@ class TagsIndex:
         """Get the display name of a given tag."""
         return self._tags.get(tagKey.lower(), {}).get("name", "")
 
-    def tagHandle(self, tagKey: str) -> str:
+    def tagHandle(self, tagKey: str) -> str | None:
         """Get the handle of a given tag."""
         return self._tags.get(tagKey.lower(), {}).get("handle", None)
 
@@ -937,6 +981,11 @@ class IndexItem:
     # Properties
     ##
 
+    @property
+    def handle(self) -> str:
+        """Return the item handle of the index item."""
+        return self._handle
+
     @property
     def item(self) -> NWItem:
         """Return the project item of the index item."""
@@ -1215,9 +1264,26 @@ class IndexHeading:
 
 
 # =============================================================================================== #
-#  Simple Word Counter
+#  Text Processing Functions
 # =============================================================================================== #
 
+CLASSIFIERS = {
+    "short": nwComment.SHORT,
+    "synopsis": nwComment.SYNOPSIS,
+}
+
+
+def processComment(text: str) -> tuple[nwComment, str, int]:
+    """Extract comment style and text. Should only be called on text
+    starting with a %.
+    """
+    check = text[1:].lstrip()
+    classifier, _, content = check.partition(":")
+    if content and (clean := classifier.strip().lower()) in CLASSIFIERS:
+        return CLASSIFIERS[clean], content.strip(), text.find(":") + 1
+    return nwComment.PLAIN, check, 0
+
+
 def countWords(text: str) -> tuple[int, int, int]:
     """Count words in a piece of text, skipping special syntax and
     comments.