Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename "brief" to "summary"

Browse Source
This commit is contained in:
Veronica Berglyd Olsen
2023-11-25 23:42:05 +01:00
parent 9fc815abe1
commit 53aa970427
16 changed files with 56 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
novelwriter/assets/i18n/project_en_GB.json
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"Synopsis": "Synopsis", "Synopsis": "Synopsis",
"Summary": "Summary",
"Comment": "Comment", "Comment": "Comment",
"Brief": "Brief",
"Notes": "Notes", "Notes": "Notes",
"Tag": "Tag", "Tag": "Tag",
"Point of View": "Point of View", "Point of View": "Point of View",
novelwriter/core/coretools.py
+1 -1
View File
@@ -450,7 +450,7 @@ class ProjectBuilder:
aDoc.writeDocument( aDoc.writeDocument(
f"# {noteTitles[newRoot]}\n\n" f"# {noteTitles[newRoot]}\n\n"
f"@tag: {ntTag}\n\n" f"@tag: {ntTag}\n\n"
f"% Brief: {bfNote}\n\n" f"% Summary: {bfNote}\n\n"
) )
# Also add the archive and trash folders # Also add the archive and trash folders
novelwriter/core/index.py
+2 -2
View File
@@ -339,7 +339,7 @@ class NWIndex:
elif line.startswith("%"): elif line.startswith("%"):
if cTitle != TT_NONE: if cTitle != TT_NONE:
cStyle, cText, _ = processComment(line) cStyle, cText, _ = processComment(line)
if cStyle in (nwComment.BRIEF, nwComment.SYNOPSIS): if cStyle in (nwComment.SYNOPSIS, nwComment.SUMMARY):
self._itemIndex.setHeadingSynopsis(tHandle, cTitle, cText) self._itemIndex.setHeadingSynopsis(tHandle, cTitle, cText)
# Count words for remaining text after last heading # Count words for remaining text after last heading
@@ -1268,7 +1268,7 @@ class IndexHeading:
# =============================================================================================== # # =============================================================================================== #
CLASSIFIERS = { CLASSIFIERS = {
"brief": nwComment.BRIEF, "summary": nwComment.SUMMARY,
"synopsis": nwComment.SYNOPSIS, "synopsis": nwComment.SYNOPSIS,
} }
novelwriter/core/tohtml.py
+2 -2
View File
@@ -289,7 +289,7 @@ class ToHtml(Tokenizer):
elif tType == self.T_SYNOPSIS and self._doSynopsis: elif tType == self.T_SYNOPSIS and self._doSynopsis:
lines.append(self._formatSynopsis(tText, True)) lines.append(self._formatSynopsis(tText, True))
elif tType == self.T_BRIEF and self._doSynopsis: elif tType == self.T_SUMMARY and self._doSynopsis:
lines.append(self._formatSynopsis(tText, False)) lines.append(self._formatSynopsis(tText, False))
elif tType == self.T_COMMENT and self._doComments: elif tType == self.T_COMMENT and self._doComments:
@@ -459,7 +459,7 @@ class ToHtml(Tokenizer):
def _formatSynopsis(self, text: str, synopsis: bool) -> str: def _formatSynopsis(self, text: str, synopsis: bool) -> str:
"""Apply HTML formatting to synopsis.""" """Apply HTML formatting to synopsis."""
sSynop = self._localLookup("Synopsis") if synopsis else self._localLookup("Brief") sSynop = self._localLookup("Synopsis") if synopsis else self._localLookup("Summary")
if self._genMode == self.M_PREVIEW: if self._genMode == self.M_PREVIEW:
return f"<p class='comment'><span class='synopsis'>{sSynop}:</span> {text}</p>\n" return f"<p class='comment'><span class='synopsis'>{sSynop}:</span> {text}</p>\n"
else: else:
novelwriter/core/tokenizer.py
+3 -3
View File
@@ -80,7 +80,7 @@ class Tokenizer(ABC):
# Block Type # Block Type
T_EMPTY = 1 # Empty line (new paragraph) T_EMPTY = 1 # Empty line (new paragraph)
T_SYNOPSIS = 2 # Synopsis comment T_SYNOPSIS = 2 # Synopsis comment
T_BRIEF = 3 # Brief comment T_SUMMARY = 3 # Summary comment
T_COMMENT = 4 # Comment line T_COMMENT = 4 # Comment line
T_KEYWORD = 5 # Command line T_KEYWORD = 5 # Command line
T_TITLE = 6 # Title T_TITLE = 6 # Title
@@ -470,9 +470,9 @@ class Tokenizer(ABC):
)) ))
if self._doSynopsis and self._keepMarkdown: if self._doSynopsis and self._keepMarkdown:
tmpMarkdown.append("%s\n" % aLine) tmpMarkdown.append("%s\n" % aLine)
elif cStyle == nwComment.BRIEF: elif cStyle == nwComment.SUMMARY:
self._tokens.append(( self._tokens.append((
self.T_BRIEF, nHead, cText, None, sAlign self.T_SUMMARY, nHead, cText, None, sAlign
)) ))
if self._doSynopsis and self._keepMarkdown: if self._doSynopsis and self._keepMarkdown:
tmpMarkdown.append("%s\n" % aLine) tmpMarkdown.append("%s\n" % aLine)
novelwriter/core/tomd.py
+2 -2
View File
@@ -170,8 +170,8 @@ class ToMarkdown(Tokenizer):
label = self._localLookup("Synopsis") label = self._localLookup("Synopsis")
lines.append(f"**{label}:** {tText}\n\n") lines.append(f"**{label}:** {tText}\n\n")
elif tType == self.T_BRIEF and self._doSynopsis: elif tType == self.T_SUMMARY and self._doSynopsis:
label = self._localLookup("Brief") label = self._localLookup("Summary")
lines.append(f"**{label}:** {tText}\n\n") lines.append(f"**{label}:** {tText}\n\n")
elif tType == self.T_COMMENT and self._doComments: elif tType == self.T_COMMENT and self._doComments:
novelwriter/core/toodt.py
+2 -2
View File
@@ -484,7 +484,7 @@ class ToOdt(Tokenizer):
tTemp, fTemp = self._formatSynopsis(tText, True) tTemp, fTemp = self._formatSynopsis(tText, True)
self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp) self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp)
elif tType == self.T_BRIEF and self._doSynopsis: elif tType == self.T_SUMMARY and self._doSynopsis:
tTemp, fTemp = self._formatSynopsis(tText, False) tTemp, fTemp = self._formatSynopsis(tText, False)
self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp) self._addTextPar("Text_20_Meta", oStyle, tTemp, tFmt=fTemp)
@@ -558,7 +558,7 @@ class ToOdt(Tokenizer):
def _formatSynopsis(self, text: str, synopsis: bool) -> tuple[str, list[tuple[int, int]]]: def _formatSynopsis(self, text: str, synopsis: bool) -> tuple[str, list[tuple[int, int]]]:
"""Apply formatting to synopsis lines.""" """Apply formatting to synopsis lines."""
name = self._localLookup("Synopsis") if synopsis else self._localLookup("Brief") name = self._localLookup("Synopsis") if synopsis else self._localLookup("Summary")
rTxt = f"{name}: {text}" rTxt = f"{name}: {text}"
rFmt = [(0, self.FMT_B_B), (len(name) + 1, self.FMT_B_E)] rFmt = [(0, self.FMT_B_B), (len(name) + 1, self.FMT_B_E)]
return rTxt, rFmt return rTxt, rFmt
novelwriter/enum.py
+1 -1
View File
@@ -65,7 +65,7 @@ class nwComment(Enum):
PLAIN = 0 PLAIN = 0
SYNOPSIS = 1 SYNOPSIS = 1
BRIEF = 2 SUMMARY = 2
# END Enum nwComment # END Enum nwComment
novelwriter/gui/docviewerpanel.py
+9 -9
View File
@@ -316,13 +316,13 @@ class _ViewPanelBackRefs(QTreeWidget):
class _ViewPanelKeyWords(QTreeWidget): class _ViewPanelKeyWords(QTreeWidget):
C_DATA = 0 C_DATA = 0
C_NAME = 0 C_NAME = 0
C_EDIT = 1 C_EDIT = 1
C_VIEW = 2 C_VIEW = 2
C_DOC = 3 C_DOC = 3
C_TITLE = 4 C_TITLE = 4
C_BRIEF = 5 C_SUMMARY = 5
D_TAG = Qt.ItemDataRole.UserRole D_TAG = Qt.ItemDataRole.UserRole
@@ -337,7 +337,7 @@ class _ViewPanelKeyWords(QTreeWidget):
self.setHeaderLabels([ self.setHeaderLabels([
self.tr("Tag"), "", "", self.tr("Document"), self.tr("Tag"), "", "", self.tr("Document"),
self.tr("Heading"), self.tr("Brief") self.tr("Heading"), self.tr("Summary")
]) ])
self.setIndentation(0) self.setIndentation(0)
self.setIconSize(QSize(iPx, iPx)) self.setIconSize(QSize(iPx, iPx))
@@ -401,7 +401,7 @@ class _ViewPanelKeyWords(QTreeWidget):
trItem.setText(self.C_DOC, nwItem.itemName) trItem.setText(self.C_DOC, nwItem.itemName)
trItem.setText(self.C_TITLE, hItem.title) trItem.setText(self.C_TITLE, hItem.title)
trItem.setData(self.C_TITLE, Qt.ItemDataRole.DecorationRole, hDec) trItem.setData(self.C_TITLE, Qt.ItemDataRole.DecorationRole, hDec)
trItem.setText(self.C_BRIEF, hItem.synopsis) trItem.setText(self.C_SUMMARY, hItem.synopsis)
trItem.setData(self.C_DATA, self.D_TAG, tag) trItem.setData(self.C_DATA, self.D_TAG, tag)
if tag not in self._treeMap: if tag not in self._treeMap:
sample/content/14298de4d9524.nwd
+1 -1
View File
@@ -7,6 +7,6 @@
@tag: John @tag: John
% Brief: The sidekick % Summary: The sidekick
He’s pretty cool. Not Brad Pitt though. He’s pretty cool. Not Brad Pitt though.
sample/content/bb2c23b3c42cc.nwd
+1 -1
View File
@@ -7,6 +7,6 @@
@tag: Jane @tag: Jane
% Brief: The heroine % Summary: The heroine
She’s pretty cool. Not Angelina Jolie though. She’s pretty cool. Not Angelina Jolie though.
tests/test_core/test_core_index.py
+10 -8
View File
@@ -1269,7 +1269,7 @@ def testCoreIndex_processComment():
# Regular comment # Regular comment
assert processComment("%Hi") == (nwComment.PLAIN, "Hi", 0) assert processComment("%Hi") == (nwComment.PLAIN, "Hi", 0)
assert processComment("% Hi") == (nwComment.PLAIN, "Hi", 0) assert processComment("% Hi") == (nwComment.PLAIN, "Hi", 0)
assert processComment("% Hi:you") == (nwComment.PLAIN, "Hi:you", 0) assert processComment("% Hi:You") == (nwComment.PLAIN, "Hi:You", 0)
# Synopsis # Synopsis
assert processComment("%synopsis:") == (nwComment.PLAIN, "synopsis:", 0) assert processComment("%synopsis:") == (nwComment.PLAIN, "synopsis:", 0)
@@ -1278,14 +1278,16 @@ def testCoreIndex_processComment():
assert processComment("% synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 13) assert processComment("% synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 13)
assert processComment("% Synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 15) assert processComment("% Synopsis : Hi") == (nwComment.SYNOPSIS, "Hi", 15)
assert processComment("% \t SYNOPSIS : Hi") == (nwComment.SYNOPSIS, "Hi", 16) assert processComment("% \t SYNOPSIS : Hi") == (nwComment.SYNOPSIS, "Hi", 16)
assert processComment("% \t SYNOPSIS : Hi:You") == (nwComment.SYNOPSIS, "Hi:You", 16)
# Brief # Summary
assert processComment("%brief:") == (nwComment.PLAIN, "brief:", 0) assert processComment("%summary:") == (nwComment.PLAIN, "summary:", 0)
assert processComment("%brief: Hi") == (nwComment.BRIEF, "Hi", 7) assert processComment("%summary: Hi") == (nwComment.SUMMARY, "Hi", 9)
assert processComment("% brief: Hi") == (nwComment.BRIEF, "Hi", 8) assert processComment("% summary: Hi") == (nwComment.SUMMARY, "Hi", 10)
assert processComment("% brief : Hi") == (nwComment.BRIEF, "Hi", 10) assert processComment("% summary : Hi") == (nwComment.SUMMARY, "Hi", 12)
assert processComment("% Brief : Hi") == (nwComment.BRIEF, "Hi", 12) assert processComment("% Summary : Hi") == (nwComment.SUMMARY, "Hi", 14)
assert processComment("% \t BRIEF : Hi") == (nwComment.BRIEF, "Hi", 13) assert processComment("% \t SUMMARY : Hi") == (nwComment.SUMMARY, "Hi", 15)
assert processComment("% \t SUMMARY : Hi:You") == (nwComment.SUMMARY, "Hi:You", 15)
# END Test testCoreIndex_processComment # END Test testCoreIndex_processComment
tests/test_core/test_core_tohtml.py
+7 -7
View File
@@ -149,7 +149,7 @@ def testCoreToHtml_ConvertFormat(mockGUI):
"<p class='break'>Line one<br/>Line two<br/>Line three</p>\n" "<p class='break'>Line one<br/>Line two<br/>Line three</p>\n"
) )
# Synopsis, Brief # Synopsis, Summary
html._text = "%synopsis: The synopsis ...\n" html._text = "%synopsis: The synopsis ...\n"
html.tokenizeText() html.tokenizeText()
html.doConvert() html.doConvert()
@@ -164,11 +164,11 @@ def testCoreToHtml_ConvertFormat(mockGUI):
) )
html.setSynopsis(True) html.setSynopsis(True)
html._text = "%brief: A description ...\n" html._text = "%summary: A description ...\n"
html.tokenizeText() html.tokenizeText()
html.doConvert() html.doConvert()
assert html.theResult == ( assert html.theResult == (
"<p class='synopsis'><strong>Brief:</strong> A description ...</p>\n" "<p class='synopsis'><strong>Summary:</strong> A description ...</p>\n"
) )
# Comment # Comment
@@ -621,8 +621,8 @@ def testCoreToHtml_Format(mockGUI):
assert html._formatSynopsis("synopsis text", True) == ( assert html._formatSynopsis("synopsis text", True) == (
"<p class='synopsis'><strong>Synopsis:</strong> synopsis text</p>\n" "<p class='synopsis'><strong>Synopsis:</strong> synopsis text</p>\n"
) )
assert html._formatSynopsis("brief text", False) == ( assert html._formatSynopsis("summary text", False) == (
"<p class='synopsis'><strong>Brief:</strong> brief text</p>\n" "<p class='synopsis'><strong>Summary:</strong> summary text</p>\n"
) )
assert html._formatComments("comment text") == ( assert html._formatComments("comment text") == (
"<p class='comment'><strong>Comment:</strong> comment text</p>\n" "<p class='comment'><strong>Comment:</strong> comment text</p>\n"
@@ -646,8 +646,8 @@ def testCoreToHtml_Format(mockGUI):
assert html._formatSynopsis("synopsis text", True) == ( assert html._formatSynopsis("synopsis text", True) == (
"<p class='comment'><span class='synopsis'>Synopsis:</span> synopsis text</p>\n" "<p class='comment'><span class='synopsis'>Synopsis:</span> synopsis text</p>\n"
) )
assert html._formatSynopsis("brief text", False) == ( assert html._formatSynopsis("summary text", False) == (
"<p class='comment'><span class='synopsis'>Brief:</span> brief text</p>\n" "<p class='comment'><span class='synopsis'>Summary:</span> summary text</p>\n"
) )
assert html._formatComments("comment text") == ( assert html._formatComments("comment text") == (
"<p class='comment'>comment text</p>\n" "<p class='comment'>comment text</p>\n"
tests/test_core/test_core_tokenizer.py
+4 -4
View File
@@ -471,19 +471,19 @@ def testCoreToken_MetaFormat(mockGUI):
tokens.tokenizeText() tokens.tokenizeText()
assert tokens.theMarkdown[-1] == "% synopsis: The synopsis\n\n" assert tokens.theMarkdown[-1] == "% synopsis: The synopsis\n\n"
# Brief # Summary
tokens.setSynopsis(False) tokens.setSynopsis(False)
tokens._text = "% brief: A description\n" tokens._text = "% summary: A description\n"
tokens.tokenizeText() tokens.tokenizeText()
assert tokens._tokens == [ assert tokens._tokens == [
(Tokenizer.T_BRIEF, 0, "A description", None, Tokenizer.A_NONE), (Tokenizer.T_SUMMARY, 0, "A description", None, Tokenizer.A_NONE),
(Tokenizer.T_EMPTY, 0, "", None, Tokenizer.A_NONE), (Tokenizer.T_EMPTY, 0, "", None, Tokenizer.A_NONE),
] ]
assert tokens.theMarkdown[-1] == "\n" assert tokens.theMarkdown[-1] == "\n"
tokens.setSynopsis(True) tokens.setSynopsis(True)
tokens.tokenizeText() tokens.tokenizeText()
assert tokens.theMarkdown[-1] == "% brief: A description\n\n" assert tokens.theMarkdown[-1] == "% summary: A description\n\n"
# Keyword # Keyword
tokens._text = "@char: Bod\n" tokens._text = "@char: Bod\n"
tests/test_core/test_core_tomd.py
+3 -3
View File
@@ -106,7 +106,7 @@ def testCoreToMarkdown_ConvertFormat(mockGUI):
theMD.doConvert() theMD.doConvert()
assert theMD.theResult == "Line one \nLine two \nLine three\n\n" assert theMD.theResult == "Line one \nLine two \nLine three\n\n"
# Synopsis, Brief # Synopsis, Summary
theMD._text = "%synopsis: The synopsis ...\n" theMD._text = "%synopsis: The synopsis ...\n"
theMD.tokenizeText() theMD.tokenizeText()
theMD.doConvert() theMD.doConvert()
@@ -119,10 +119,10 @@ def testCoreToMarkdown_ConvertFormat(mockGUI):
assert theMD.theResult == "**Synopsis:** The synopsis ...\n\n" assert theMD.theResult == "**Synopsis:** The synopsis ...\n\n"
theMD.setSynopsis(True) theMD.setSynopsis(True)
theMD._text = "%brief: A description ...\n" theMD._text = "%summary: A description ...\n"
theMD.tokenizeText() theMD.tokenizeText()
theMD.doConvert() theMD.doConvert()
assert theMD.theResult == "**Brief:** A description ...\n\n" assert theMD.theResult == "**Summary:** A description ...\n\n"
# Comment # Comment
theMD._text = "% A comment ...\n" theMD._text = "% A comment ...\n"
tests/test_core/test_core_toodt.py
+5 -5
View File
@@ -447,12 +447,12 @@ def testCoreToOdt_Convert(mockGUI):
'</office:text>' '</office:text>'
) )
# Synopsis, Brief, Comment, Keywords # Synopsis, Summary, Comment, Keywords
odt._text = ( odt._text = (
"### Scene\n\n" "### Scene\n\n"
"@pov: Jane\n\n" "@pov: Jane\n\n"
"% synopsis: So it begins\n\n" "% synopsis: So it begins\n\n"
"% brief: Then what\n\n" "% summary: Then what\n\n"
"% A plain comment\n\n" "% A plain comment\n\n"
) )
odt.setSynopsis(True) odt.setSynopsis(True)
@@ -471,7 +471,7 @@ def testCoreToOdt_Convert(mockGUI):
'<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">' '<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">'
'Synopsis:</text:span> So it begins</text:p>' 'Synopsis:</text:span> So it begins</text:p>'
'<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">' '<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">'
'Brief:</text:span> Then what</text:p>' 'Summary:</text:span> Then what</text:p>'
'<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">' '<text:p text:style-name="Text_20_Meta"><text:span text:style-name="T7">'
'Comment:</text:span> A plain comment</text:p>' 'Comment:</text:span> A plain comment</text:p>'
'</office:text>' '</office:text>'
@@ -810,8 +810,8 @@ def testCoreToOdt_Format(mockGUI):
assert odt._formatSynopsis("synopsis text", True) == ( assert odt._formatSynopsis("synopsis text", True) == (
"Synopsis: synopsis text", [(0, ToOdt.FMT_B_B), (9, ToOdt.FMT_B_E)] "Synopsis: synopsis text", [(0, ToOdt.FMT_B_B), (9, ToOdt.FMT_B_E)]
) )
assert odt._formatSynopsis("brief text", False) == ( assert odt._formatSynopsis("summary text", False) == (
"Brief: brief text", [(0, ToOdt.FMT_B_B), (6, ToOdt.FMT_B_E)] "Summary: summary text", [(0, ToOdt.FMT_B_B), (8, ToOdt.FMT_B_E)]
) )
assert odt._formatComments("comment text") == ( assert odt._formatComments("comment text") == (
"Comment: comment text", [(0, ToOdt.FMT_B_B), (8, ToOdt.FMT_B_E)] "Comment: comment text", [(0, ToOdt.FMT_B_B), (8, ToOdt.FMT_B_E)]