From 887b4379b2ee921b9b8df8bd022ede270781d78a Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 17:50:25 +0100
Subject: [PATCH 1/6] Add comment style processing to the index class
---
novelwriter/core/index.py | 32 ++++++++++++++++++++++----------
novelwriter/enum.py | 9 +++++++++
2 files changed, 31 insertions(+), 10 deletions(-)
diff --git a/novelwriter/core/index.py b/novelwriter/core/index.py
index 3c833b2c..2c76c3ae 100644
--- a/novelwriter/core/index.py
+++ b/novelwriter/core/index.py
@@ -36,7 +36,7 @@ from typing import TYPE_CHECKING, ItemsView, Iterable, Iterator
from pathlib import Path
from novelwriter import SHARED
-from novelwriter.enum import nwItemClass, nwItemType, nwItemLayout
+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
@@ -338,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.BRIEF, nwComment.SYNOPSIS):
+ self._itemIndex.setHeadingSynopsis(tHandle, cTitle, cText)
# Count words for remaining text after last heading
if pTitle != TT_NONE:
@@ -1269,9 +1264,26 @@ class IndexHeading:
# =============================================================================================== #
-# Simple Word Counter
+# text Processing Functions
# =============================================================================================== #
+CLASSIFIERS = {
+ "brief": nwComment.BRIEF,
+ "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.
diff --git a/novelwriter/enum.py b/novelwriter/enum.py
index c1d2aef4..1258e5e2 100644
--- a/novelwriter/enum.py
+++ b/novelwriter/enum.py
@@ -61,6 +61,15 @@ class nwItemLayout(Enum):
# END Enum nwItemLayout
+class nwComment(Enum):
+
+ PLAIN = 0
+ SYNOPSIS = 1
+ BRIEF = 2
+
+# END Enum nwComment
+
+
class nwTrinary(Enum):
NEGATIVE = -1
From 8ed85363e2162140c8790b419be6e4fe5b02ece1 Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 17:50:59 +0100
Subject: [PATCH 2/6] Add test coverage and update the highlighter
---
novelwriter/gui/dochighlight.py | 16 ++++++--------
tests/test_core/test_core_index.py | 35 ++++++++++++++++++++++++++----
2 files changed, 38 insertions(+), 13 deletions(-)
diff --git a/novelwriter/gui/dochighlight.py b/novelwriter/gui/dochighlight.py
index 6a77f267..b6850097 100644
--- a/novelwriter/gui/dochighlight.py
+++ b/novelwriter/gui/dochighlight.py
@@ -36,6 +36,8 @@ from PyQt5.QtGui import (
from novelwriter import CONFIG, SHARED
from novelwriter.common import checkInt
from novelwriter.constants import nwRegEx, nwUnicode
+from novelwriter.core.index import processComment
+from novelwriter.enum import nwComment
logger = logging.getLogger(__name__)
@@ -352,16 +354,12 @@ class GuiDocHighlighter(QSyntaxHighlighter):
elif text.startswith("%"): # Comments
self.setCurrentBlockState(self.BLOCK_TEXT)
- toCheck = text[1:].lstrip()
- synTag = toCheck[:9].lower()
- tLen = len(text)
- cLen = len(toCheck)
- cOff = tLen - cLen
- if synTag == "synopsis:":
- self.setFormat(0, cOff+9, self._hStyles["modifier"])
- self.setFormat(cOff+9, tLen, self._hStyles["hidden"])
+ cStyle, _, cPos = processComment(text)
+ if cStyle == nwComment.PLAIN:
+ self.setFormat(0, len(text), self._hStyles["hidden"])
else:
- self.setFormat(0, tLen, self._hStyles["hidden"])
+ self.setFormat(0, cPos, self._hStyles["modifier"])
+ self.setFormat(cPos, len(text), self._hStyles["hidden"])
else: # Text Paragraph
diff --git a/tests/test_core/test_core_index.py b/tests/test_core/test_core_index.py
index 9e7856e8..d12ab318 100644
--- a/tests/test_core/test_core_index.py
+++ b/tests/test_core/test_core_index.py
@@ -29,9 +29,9 @@ from mocked import causeException
from novelwriter.core.item import NWItem
from tools import C, buildTestProject, cmpFiles, writeFile
-from novelwriter.enum import nwItemClass, nwItemLayout
+from novelwriter.enum import nwComment, nwItemClass, nwItemLayout
from novelwriter.constants import nwFiles
-from novelwriter.core.index import IndexItem, NWIndex, countWords, TagsIndex
+from novelwriter.core.index import IndexItem, NWIndex, countWords, TagsIndex, processComment
from novelwriter.core.project import NWProject
@@ -1264,7 +1264,34 @@ def testCoreIndex_ItemIndex(mockGUI, fncPath, mockRnd):
@pytest.mark.core
-def testCoreIndex_CountWords():
+def testCoreIndex_processComment():
+ """Test the comment processing function."""
+ # Regular comment
+ assert processComment("%Hi") == (nwComment.PLAIN, "Hi", 0)
+ assert processComment("% Hi") == (nwComment.PLAIN, "Hi", 0)
+ assert processComment("% Hi:you") == (nwComment.PLAIN, "Hi:you", 0)
+
+ # Synopsis
+ assert processComment("%synopsis:") == (nwComment.PLAIN, "synopsis:", 0)
+ assert processComment("%synopsis: Hi") == (nwComment.SYNOPSIS, "Hi", 10)
+ assert processComment("% synopsis: Hi") == (nwComment.SYNOPSIS, "Hi", 11)
+ assert processComment("% synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 13)
+ assert processComment("% Synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 15)
+ assert processComment("% \t SYNOPSIS : Hi") == (nwComment.SYNOPSIS, "Hi", 16)
+
+ # Brief
+ assert processComment("%brief:") == (nwComment.PLAIN, "brief:", 0)
+ assert processComment("%brief: Hi") == (nwComment.BRIEF, "Hi", 7)
+ assert processComment("% brief: Hi") == (nwComment.BRIEF, "Hi", 8)
+ assert processComment("% brief : Hi") == (nwComment.BRIEF, "Hi", 10)
+ assert processComment("% Brief : Hi") == (nwComment.BRIEF, "Hi", 12)
+ assert processComment("% \t BRIEF : Hi") == (nwComment.BRIEF, "Hi", 13)
+
+# END Test testCoreIndex_processComment
+
+
+@pytest.mark.core
+def testCoreIndex_countWords():
"""Test the word counter and the exclusion filers."""
# Non-Text
assert countWords(None) == (0, 0, 0) # type: ignore
@@ -1362,4 +1389,4 @@ def testCoreIndex_CountWords():
assert wC == 14
assert pC == 2
-# END Test testCoreIndex_CountWords
+# END Test testCoreIndex_countWords
From 6a6b05c3380e60c82447685b85995643e273002a Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 18:12:45 +0100
Subject: [PATCH 3/6] Update tokenizer and converters
---
novelwriter/core/coretools.py | 7 ++++-
novelwriter/core/tohtml.py | 9 ++++--
novelwriter/core/tokenizer.py | 41 +++++++++++++++-----------
novelwriter/core/tomd.py | 4 +++
novelwriter/core/toodt.py | 10 +++++--
tests/test_core/test_core_tohtml.py | 20 +++++++++++--
tests/test_core/test_core_tokenizer.py | 14 +++++++++
tests/test_core/test_core_tomd.py | 8 ++++-
tests/test_core/test_core_toodt.py | 14 ++++++---
9 files changed, 95 insertions(+), 32 deletions(-)
diff --git a/novelwriter/core/coretools.py b/novelwriter/core/coretools.py
index 81803576..fd040461 100644
--- a/novelwriter/core/coretools.py
+++ b/novelwriter/core/coretools.py
@@ -406,6 +406,7 @@ class ProjectBuilder:
chSynop = self.tr("Summary of the chapter.")
scSynop = self.tr("Summary of the scene.")
+ bfNote = self.tr("A brief description.")
# Create chapters
if numChapters > 0:
@@ -446,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"% Brief: {bfNote}\n\n"
+ f"@tag: {ntTag}\n\n"
+ )
# Also add the archive and trash folders
project.newRoot(nwItemClass.ARCHIVE)
diff --git a/novelwriter/core/tohtml.py b/novelwriter/core/tohtml.py
index 7443ed34..219f6032 100644
--- a/novelwriter/core/tohtml.py
+++ b/novelwriter/core/tohtml.py
@@ -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_BRIEF 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,9 @@ 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")
+ sSynop = self._localLookup("Synopsis") if synopsis else self._localLookup("Brief")
if self._genMode == self.M_PREVIEW:
return f"\n"
else:
diff --git a/novelwriter/core/tokenizer.py b/novelwriter/core/tokenizer.py
index a4e7f61a..b5d0fd18 100644
--- a/novelwriter/core/tokenizer.py
+++ b/novelwriter/core/tokenizer.py
@@ -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_BRIEF = 3 # Brief 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
@@ -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.BRIEF:
+ self._tokens.append((
+ self.T_BRIEF, 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)
diff --git a/novelwriter/core/tomd.py b/novelwriter/core/tomd.py
index d13e3b18..3187258a 100644
--- a/novelwriter/core/tomd.py
+++ b/novelwriter/core/tomd.py
@@ -170,6 +170,10 @@ class ToMarkdown(Tokenizer):
label = self._localLookup("Synopsis")
lines.append(f"**{label}:** {tText}\n\n")
+ elif tType == self.T_BRIEF and self._doSynopsis:
+ label = self._localLookup("Brief")
+ 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")
diff --git a/novelwriter/core/toodt.py b/novelwriter/core/toodt.py
index aec5eefb..26cc76b2 100644
--- a/novelwriter/core/toodt.py
+++ b/novelwriter/core/toodt.py
@@ -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_BRIEF 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,9 @@ 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")
+ name = self._localLookup("Synopsis") if synopsis else self._localLookup("Brief")
rTxt = f"{name}: {text}"
rFmt = [(0, self.FMT_B_B), (len(name) + 1, self.FMT_B_E)]
return rTxt, rFmt
diff --git a/tests/test_core/test_core_tohtml.py b/tests/test_core/test_core_tohtml.py
index b0776ef6..7f616155 100644
--- a/tests/test_core/test_core_tohtml.py
+++ b/tests/test_core/test_core_tohtml.py
@@ -149,7 +149,7 @@ def testCoreToHtml_ConvertFormat(mockGUI):
"Line one
Line two
Line three
\n"
)
- # Synopsis
+ # Synopsis, Brief
html._text = "%synopsis: The synopsis ...\n"
html.tokenizeText()
html.doConvert()
@@ -163,6 +163,14 @@ def testCoreToHtml_ConvertFormat(mockGUI):
"Synopsis: The synopsis ...
\n"
)
+ html.setSynopsis(True)
+ html._text = "%brief: A description ...\n"
+ html.tokenizeText()
+ html.doConvert()
+ assert html.theResult == (
+ "Brief: A description ...
\n"
+ )
+
# Comment
html._text = "% A comment ...\n"
html.tokenizeText()
@@ -610,9 +618,12 @@ def testCoreToHtml_Format(mockGUI):
# Export Mode
# ===========
- assert html._formatSynopsis("synopsis text") == (
+ assert html._formatSynopsis("synopsis text", True) == (
"Synopsis: synopsis text
\n"
)
+ assert html._formatSynopsis("brief text", False) == (
+ "Brief: brief text
\n"
+ )
assert html._formatComments("comment text") == (
"\n"
)
@@ -632,9 +643,12 @@ def testCoreToHtml_Format(mockGUI):
html.setPreview(True, True)
- assert html._formatSynopsis("synopsis text") == (
+ assert html._formatSynopsis("synopsis text", True) == (
"\n"
)
+ assert html._formatSynopsis("brief text", False) == (
+ "\n"
+ )
assert html._formatComments("comment text") == (
"\n"
)
diff --git a/tests/test_core/test_core_tokenizer.py b/tests/test_core/test_core_tokenizer.py
index c218b7d7..3dc513ce 100644
--- a/tests/test_core/test_core_tokenizer.py
+++ b/tests/test_core/test_core_tokenizer.py
@@ -471,6 +471,20 @@ def testCoreToken_MetaFormat(mockGUI):
tokens.tokenizeText()
assert tokens.theMarkdown[-1] == "% synopsis: The synopsis\n\n"
+ # Brief
+ tokens.setSynopsis(False)
+ tokens._text = "% brief: A description\n"
+ tokens.tokenizeText()
+ assert tokens._tokens == [
+ (Tokenizer.T_BRIEF, 0, "A description", None, Tokenizer.A_NONE),
+ (Tokenizer.T_EMPTY, 0, "", None, Tokenizer.A_NONE),
+ ]
+ assert tokens.theMarkdown[-1] == "\n"
+
+ tokens.setSynopsis(True)
+ tokens.tokenizeText()
+ assert tokens.theMarkdown[-1] == "% brief: A description\n\n"
+
# Keyword
tokens._text = "@char: Bod\n"
tokens.tokenizeText()
diff --git a/tests/test_core/test_core_tomd.py b/tests/test_core/test_core_tomd.py
index c44447a4..78e94230 100644
--- a/tests/test_core/test_core_tomd.py
+++ b/tests/test_core/test_core_tomd.py
@@ -106,7 +106,7 @@ def testCoreToMarkdown_ConvertFormat(mockGUI):
theMD.doConvert()
assert theMD.theResult == "Line one \nLine two \nLine three\n\n"
- # Synopsis
+ # Synopsis, Brief
theMD._text = "%synopsis: The synopsis ...\n"
theMD.tokenizeText()
theMD.doConvert()
@@ -118,6 +118,12 @@ def testCoreToMarkdown_ConvertFormat(mockGUI):
theMD.doConvert()
assert theMD.theResult == "**Synopsis:** The synopsis ...\n\n"
+ theMD.setSynopsis(True)
+ theMD._text = "%brief: A description ...\n"
+ theMD.tokenizeText()
+ theMD.doConvert()
+ assert theMD.theResult == "**Brief:** A description ...\n\n"
+
# Comment
theMD._text = "% A comment ...\n"
theMD.tokenizeText()
diff --git a/tests/test_core/test_core_toodt.py b/tests/test_core/test_core_toodt.py
index ab6bf41c..04d5180b 100644
--- a/tests/test_core/test_core_toodt.py
+++ b/tests/test_core/test_core_toodt.py
@@ -447,12 +447,13 @@ def testCoreToOdt_Convert(mockGUI):
''
)
- # Synopsis, Comment, Keywords
+ # Synopsis, Brief, Comment, Keywords
odt._text = (
"### Scene\n\n"
"@pov: Jane\n\n"
"% synopsis: So it begins\n\n"
- "% a plain comment\n\n"
+ "% brief: Then what\n\n"
+ "% A plain comment\n\n"
)
odt.setSynopsis(True)
odt.setComments(True)
@@ -470,7 +471,9 @@ def testCoreToOdt_Convert(mockGUI):
''
'Synopsis: So it begins'
''
- 'Comment: a plain comment'
+ 'Brief: Then what'
+ ''
+ 'Comment: A plain comment'
''
)
@@ -804,9 +807,12 @@ def testCoreToOdt_Format(mockGUI):
project = NWProject()
odt = ToOdt(project, isFlat=True)
- assert odt._formatSynopsis("synopsis text") == (
+ assert odt._formatSynopsis("synopsis text", True) == (
"Synopsis: synopsis text", [(0, ToOdt.FMT_B_B), (9, ToOdt.FMT_B_E)]
)
+ assert odt._formatSynopsis("brief text", False) == (
+ "Brief: brief text", [(0, ToOdt.FMT_B_B), (6, ToOdt.FMT_B_E)]
+ )
assert odt._formatComments("comment text") == (
"Comment: comment text", [(0, ToOdt.FMT_B_B), (8, ToOdt.FMT_B_E)]
)
From 519e5857d16d5f2195d3b8cf1813811a67ea728d Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 18:23:09 +0100
Subject: [PATCH 4/6] Add a column to viewer panel to show the brief
---
novelwriter/assets/i18n/project_en_GB.json | 1 +
novelwriter/core/coretools.py | 2 +-
novelwriter/core/index.py | 2 +-
novelwriter/gui/docviewerpanel.py | 8 ++++++--
sample/content/14298de4d9524.nwd | 6 ++++--
sample/content/bb2c23b3c42cc.nwd | 6 ++++--
sample/nwProject.nwx | 8 ++++----
7 files changed, 21 insertions(+), 12 deletions(-)
diff --git a/novelwriter/assets/i18n/project_en_GB.json b/novelwriter/assets/i18n/project_en_GB.json
index d29160b8..f630e22f 100644
--- a/novelwriter/assets/i18n/project_en_GB.json
+++ b/novelwriter/assets/i18n/project_en_GB.json
@@ -1,6 +1,7 @@
{
"Synopsis": "Synopsis",
"Comment": "Comment",
+ "Brief": "Brief",
"Notes": "Notes",
"Tag": "Tag",
"Point of View": "Point of View",
diff --git a/novelwriter/core/coretools.py b/novelwriter/core/coretools.py
index fd040461..fe0b1ba7 100644
--- a/novelwriter/core/coretools.py
+++ b/novelwriter/core/coretools.py
@@ -449,8 +449,8 @@ class ProjectBuilder:
aDoc = project.storage.getDocument(aHandle)
aDoc.writeDocument(
f"# {noteTitles[newRoot]}\n\n"
- f"% Brief: {bfNote}\n\n"
f"@tag: {ntTag}\n\n"
+ f"% Brief: {bfNote}\n\n"
)
# Also add the archive and trash folders
diff --git a/novelwriter/core/index.py b/novelwriter/core/index.py
index 2c76c3ae..1f47256b 100644
--- a/novelwriter/core/index.py
+++ b/novelwriter/core/index.py
@@ -1264,7 +1264,7 @@ class IndexHeading:
# =============================================================================================== #
-# text Processing Functions
+# Text Processing Functions
# =============================================================================================== #
CLASSIFIERS = {
diff --git a/novelwriter/gui/docviewerpanel.py b/novelwriter/gui/docviewerpanel.py
index 5f4f4cc6..e45820e8 100644
--- a/novelwriter/gui/docviewerpanel.py
+++ b/novelwriter/gui/docviewerpanel.py
@@ -295,6 +295,7 @@ class _ViewPanelKeyWords(QTreeWidget):
C_VIEW = 2
C_DOC = 3
C_TITLE = 4
+ C_BRIEF = 5
D_TAG = Qt.ItemDataRole.UserRole
@@ -307,7 +308,10 @@ class _ViewPanelKeyWords(QTreeWidget):
iPx = SHARED.theme.baseIconSize
cMg = CONFIG.pxInt(6)
- self.setHeaderLabels([self.tr("Tag"), "", "", self.tr("Document"), self.tr("Heading")])
+ self.setHeaderLabels([
+ self.tr("Tag"), "", "", self.tr("Document"),
+ self.tr("Heading"), self.tr("Brief")
+ ])
self.setIndentation(0)
self.setSelectionMode(QAbstractItemView.SelectionMode.NoSelection)
self.setIconSize(QSize(iPx, iPx))
@@ -321,7 +325,6 @@ class _ViewPanelKeyWords(QTreeWidget):
treeHeader.setSectionResizeMode(self.C_NAME, QHeaderView.ResizeMode.ResizeToContents)
treeHeader.setSectionResizeMode(self.C_EDIT, QHeaderView.ResizeMode.Fixed)
treeHeader.setSectionResizeMode(self.C_VIEW, QHeaderView.ResizeMode.Fixed)
- treeHeader.setSectionResizeMode(self.C_DOC, QHeaderView.ResizeMode.ResizeToContents)
treeHeader.resizeSection(self.C_EDIT, iPx + cMg)
treeHeader.resizeSection(self.C_VIEW, iPx + cMg)
@@ -367,6 +370,7 @@ class _ViewPanelKeyWords(QTreeWidget):
trItem.setText(self.C_DOC, nwItem.itemName)
trItem.setText(self.C_TITLE, hItem.title)
trItem.setData(self.C_TITLE, Qt.ItemDataRole.DecorationRole, hDec)
+ trItem.setText(self.C_BRIEF, hItem.synopsis)
trItem.setData(self.C_DATA, self.D_TAG, tag)
if tag not in self._treeMap:
diff --git a/sample/content/14298de4d9524.nwd b/sample/content/14298de4d9524.nwd
index 0f69520e..6150d624 100644
--- a/sample/content/14298de4d9524.nwd
+++ b/sample/content/14298de4d9524.nwd
@@ -1,10 +1,12 @@
%%~name: John Smith
%%~path: f7e2d9f330615/14298de4d9524
%%~kind: CHARACTER/NOTE
-%%~hash: 259eff30f10e101cf93e27e8764e851d356d54b8
-%%~date: Unknown/2023-08-25 16:52:03
+%%~hash: fda91c416d874aa41a47fceaedb3d62f040c7e32
+%%~date: Unknown/2023-11-25 18:16:13
# John Smith
@tag: John
+% Brief: The sidekick
+
He’s pretty cool. Not Brad Pitt though.
\ No newline at end of file
diff --git a/sample/content/bb2c23b3c42cc.nwd b/sample/content/bb2c23b3c42cc.nwd
index 28175909..d028a12c 100644
--- a/sample/content/bb2c23b3c42cc.nwd
+++ b/sample/content/bb2c23b3c42cc.nwd
@@ -1,10 +1,12 @@
%%~name: Jane Smith
%%~path: f7e2d9f330615/bb2c23b3c42cc
%%~kind: CHARACTER/NOTE
-%%~hash: a69e4ca6ceede2536c8d364f88e6b62ef0ec36c3
-%%~date: Unknown/2023-08-25 16:52:04
+%%~hash: b7291713899bd0356617a36ae606b08e5fee1b65
+%%~date: Unknown/2023-11-25 18:16:07
# Jane Smith
@tag: Jane
+% Brief: The heroine
+
She’s pretty cool. Not Angelina Jolie though.
\ No newline at end of file
diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx
index f2f09e9c..ea845e2c 100644
--- a/sample/nwProject.nwx
+++ b/sample/nwProject.nwx
@@ -1,6 +1,6 @@
-
-
+
+
Sample Project
Sample Project
Jane Smith
@@ -102,11 +102,11 @@
Main Characters
-
-
+
John Smith
-
-
+
Jane Smith
-
From 05e63cb01e767226267dfa32706ceefb20f7f2d9 Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 18:45:06 +0100
Subject: [PATCH 5/6] Make the columns in the viewer panel resizeable
---
novelwriter/core/options.py | 3 +++
novelwriter/gui/docviewerpanel.py | 39 +++++++++++++++++++++++++++++--
novelwriter/guimain.py | 2 ++
3 files changed, 42 insertions(+), 2 deletions(-)
diff --git a/novelwriter/core/options.py b/novelwriter/core/options.py
index 48a0c594..8019dee1 100644
--- a/novelwriter/core/options.py
+++ b/novelwriter/core/options.py
@@ -69,6 +69,9 @@ VALID_MAP = {
"GuiManuscriptBuild": {
"winWidth", "winHeight", "fmtWidth", "sumWidth",
},
+ "GuiDocViewerPanel": {
+ "colWidths",
+ }
}
diff --git a/novelwriter/gui/docviewerpanel.py b/novelwriter/gui/docviewerpanel.py
index e45820e8..c8f56fd6 100644
--- a/novelwriter/gui/docviewerpanel.py
+++ b/novelwriter/gui/docviewerpanel.py
@@ -34,9 +34,10 @@ from PyQt5.QtWidgets import (
)
from novelwriter import CONFIG, SHARED
+from novelwriter.enum import nwDocMode, nwItemClass
+from novelwriter.common import checkInt
from novelwriter.constants import nwHeaders, nwLabels, nwLists, trConst
from novelwriter.core.index import IndexHeading, IndexItem
-from novelwriter.enum import nwDocMode, nwItemClass
logger = logging.getLogger(__name__)
@@ -103,6 +104,23 @@ class GuiDocViewerPanel(QWidget):
return
+ def openProjectTasks(self) -> None:
+ """Run open project tasks."""
+ widths = SHARED.project.options.getValue("GuiDocViewerPanel", "colWidths", {})
+ if isinstance(widths, dict):
+ for key, value in widths.items():
+ if key in self.kwTabs and isinstance(value, list):
+ self.kwTabs[key].setColumnWidths(value)
+ return
+
+ def closeProjectTasks(self) -> None:
+ """Run close project tasks."""
+ widths = {}
+ for key, tab in self.kwTabs.items():
+ widths[key] = tab.getColumnWidths()
+ SHARED.project.options.setValue("GuiDocViewerPanel", "colWidths", widths)
+ return
+
##
# Public Slots
##
@@ -313,9 +331,11 @@ class _ViewPanelKeyWords(QTreeWidget):
self.tr("Heading"), self.tr("Brief")
])
self.setIndentation(0)
- self.setSelectionMode(QAbstractItemView.SelectionMode.NoSelection)
self.setIconSize(QSize(iPx, iPx))
self.setFrameStyle(QFrame.Shape.NoFrame)
+ self.setSelectionMode(QAbstractItemView.SelectionMode.NoSelection)
+ self.setExpandsOnDoubleClick(False)
+ self.setDragEnabled(False)
self.setSortingEnabled(True)
self.sortByColumn(self.C_NAME, Qt.SortOrder.AscendingOrder)
@@ -327,6 +347,7 @@ class _ViewPanelKeyWords(QTreeWidget):
treeHeader.setSectionResizeMode(self.C_VIEW, QHeaderView.ResizeMode.Fixed)
treeHeader.resizeSection(self.C_EDIT, iPx + cMg)
treeHeader.resizeSection(self.C_VIEW, iPx + cMg)
+ treeHeader.setSectionsMovable(False)
# Cache Icons Locally
self._classIcon = SHARED.theme.getIcon(nwLabels.CLASS_ICON[itemClass])
@@ -387,6 +408,20 @@ class _ViewPanelKeyWords(QTreeWidget):
return True
return False
+ def setColumnWidths(self, widths: list[int]) -> None:
+ """Set the column widths."""
+ if isinstance(widths, list) and len(widths) >= 2:
+ self.setColumnWidth(self.C_DOC, CONFIG.pxInt(checkInt(widths[0], 100)))
+ self.setColumnWidth(self.C_TITLE, CONFIG.pxInt(checkInt(widths[1], 100)))
+ return
+
+ def getColumnWidths(self) -> list[int]:
+ """Get the widths of the user-adjustable columns."""
+ return [
+ CONFIG.rpxInt(self.columnWidth(self.C_DOC)),
+ CONFIG.rpxInt(self.columnWidth(self.C_TITLE)),
+ ]
+
##
# Private Slots
##
diff --git a/novelwriter/guimain.py b/novelwriter/guimain.py
index 2006213e..54857de8 100644
--- a/novelwriter/guimain.py
+++ b/novelwriter/guimain.py
@@ -454,6 +454,7 @@ class GuiMain(QMainWindow):
self.docViewer.clearNavHistory()
self.closeDocViewer(byUser=False)
+ self.docViewerPanel.closeProjectTasks()
self.outlineView.closeProjectTasks()
self.novelView.closeProjectTasks()
self.projView.clearProjectView()
@@ -527,6 +528,7 @@ class GuiMain(QMainWindow):
self.projView.openProjectTasks()
self.novelView.openProjectTasks()
self.outlineView.openProjectTasks()
+ self.docViewerPanel.openProjectTasks()
self._updateStatusWordCount()
# Restore previously open documents, if any
From b17b5d32c213c5ae1d9c6b8044942a910511e95f Mon Sep 17 00:00:00 2001
From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>
Date: Sat, 25 Nov 2023 18:53:11 +0100
Subject: [PATCH 6/6] Allow double-clicking in viewer panel
---
novelwriter/gui/docviewerpanel.py | 18 ++++++++++++++++++
tests/test_gui/test_gui_docviewerpanel.py | 8 ++++++++
2 files changed, 26 insertions(+)
diff --git a/novelwriter/gui/docviewerpanel.py b/novelwriter/gui/docviewerpanel.py
index c8f56fd6..3d6bdfdd 100644
--- a/novelwriter/gui/docviewerpanel.py
+++ b/novelwriter/gui/docviewerpanel.py
@@ -231,6 +231,7 @@ class _ViewPanelBackRefs(QTreeWidget):
# Signals
self.clicked.connect(self._treeItemClicked)
+ self.doubleClicked.connect(self._treeItemDoubleClicked)
return
@@ -271,6 +272,14 @@ class _ViewPanelBackRefs(QTreeWidget):
self._parent.openDocumentRequest.emit(tHandle, nwDocMode.VIEW, "", True)
return
+ @pyqtSlot("QModelIndex")
+ def _treeItemDoubleClicked(self, index: QModelIndex) -> None:
+ """Emit follow tag signal on user double click."""
+ tHandle = index.siblingAtColumn(self.C_DATA).data(self.D_HANDLE)
+ if index.column() == self.C_DOC:
+ self._parent.openDocumentRequest.emit(tHandle, nwDocMode.VIEW, "", True)
+ return
+
##
# Internal Functions
##
@@ -356,6 +365,7 @@ class _ViewPanelKeyWords(QTreeWidget):
# Signals
self.clicked.connect(self._treeItemClicked)
+ self.doubleClicked.connect(self._treeItemDoubleClicked)
return
@@ -436,4 +446,12 @@ class _ViewPanelKeyWords(QTreeWidget):
self._parent.loadDocumentTagRequest.emit(tag, nwDocMode.VIEW)
return
+ @pyqtSlot("QModelIndex")
+ def _treeItemDoubleClicked(self, index: QModelIndex) -> None:
+ """Emit follow tag signal on user double click."""
+ tag = index.siblingAtColumn(self.C_DATA).data(self.D_TAG)
+ if index.column() == self.C_NAME:
+ self._parent.loadDocumentTagRequest.emit(tag, nwDocMode.VIEW)
+ return
+
# END Class _ViewPanelKeyWords
diff --git a/tests/test_gui/test_gui_docviewerpanel.py b/tests/test_gui/test_gui_docviewerpanel.py
index 1ff773ae..da43c4f3 100644
--- a/tests/test_gui/test_gui_docviewerpanel.py
+++ b/tests/test_gui/test_gui_docviewerpanel.py
@@ -102,6 +102,12 @@ def testGuiViewerPanel_BackRefs(qtbot, monkeypatch, nwGUI, projPath, mockRnd):
tabBackRefs._treeItemClicked(tabBackRefs.model().index(0, tabBackRefs.C_VIEW))
assert nwGUI.docViewer.docHandle == C.hSceneDoc
+ # Double-Click
+ nwGUI.viewDocument(hJane)
+ assert nwGUI.docViewer.docHandle == hJane
+ tabBackRefs._treeItemDoubleClicked(tabBackRefs.model().index(0, tabBackRefs.C_DOC))
+ assert nwGUI.docViewer.docHandle == C.hSceneDoc
+
# qtbot.stop()
# END Test testGuiViewerPanel_BackRefs
@@ -189,6 +195,8 @@ def testGuiViewerPanel_Tags(qtbot, monkeypatch, caplog, nwGUI, projPath, mockRnd
assert nwGUI.docViewer.docHandle == C.hSceneDoc
charTab._treeItemClicked(charTab.model().index(1, charTab.C_VIEW))
assert nwGUI.docViewer.docHandle == hJohn
+ charTab._treeItemDoubleClicked(charTab.model().index(0, charTab.C_NAME))
+ assert nwGUI.docViewer.docHandle == hJane
# qtbot.stop()