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

novelwriter/core/tomd.py

@@ -38,12 +38,12 @@ class ToMarkdown(Tokenizer):
     """Core: Markdown Document Writer
 
     Extend the Tokenizer class to writer Markdown output. It supports
-    both Standard Markdown and GitHub Flavour Markdown (Extended). The
-    class also supports concatenating novelWriter markup files.
+    both Standard Markdown and Extended Markdown. The class also
+    supports concatenating novelWriter markup files.
     """
 
     M_STD = 0  # Standard Markdown
-    M_GH  = 1  # GitHub Markdown
+    M_EXT = 1  # Extended Markdown
 
     def __init__(self, project: NWProject) -> None:
         super().__init__(project)
@@ -65,11 +65,13 @@ class ToMarkdown(Tokenizer):
     ##
 
     def setStandardMarkdown(self) -> None:
+        """Set the converter to use standard Markdown formatting."""
         self._genMode = self.M_STD
         return
 
-    def setGitHubMarkdown(self) -> None:
-        self._genMode = self.M_GH
+    def setExtendedMarkdown(self) -> None:
+        """Set the converter to use Extended Markdown formatting."""
+        self._genMode = self.M_EXT
         return
 
     ##
@@ -78,14 +80,12 @@ class ToMarkdown(Tokenizer):
 
     def getFullResultSize(self) -> int:
         """Return the size of the full Markdown result."""
-        return sum([len(x) for x in self._fullMD])
+        return sum(len(x) for x in self._fullMD)
 
     def doConvert(self) -> None:
-        """Convert the list of text tokens into a HTML document saved
-        to theResult.
-        """
+        """Convert the list of text tokens into a Markdown document."""
         if self._genMode == self.M_STD:
-            # Standard
+            # Standard Markdown
             mdTags = {
                 self.FMT_B_B: "**",
                 self.FMT_B_E: "**",
@@ -93,9 +93,15 @@ class ToMarkdown(Tokenizer):
                 self.FMT_I_E: "_",
                 self.FMT_D_B: "",
                 self.FMT_D_E: "",
+                self.FMT_U_B: "",
+                self.FMT_U_E: "",
+                self.FMT_SUP_B: "",
+                self.FMT_SUP_E: "",
+                self.FMT_SUB_B: "",
+                self.FMT_SUB_E: "",
             }
         else:
-            # GitHub
+            # Extended Markdown
             mdTags = {
                 self.FMT_B_B: "**",
                 self.FMT_B_E: "**",
@@ -103,72 +109,79 @@ class ToMarkdown(Tokenizer):
                 self.FMT_I_E: "_",
                 self.FMT_D_B: "~~",
                 self.FMT_D_E: "~~",
+                self.FMT_U_B: "",
+                self.FMT_U_E: "",
+                self.FMT_SUP_B: "^",
+                self.FMT_SUP_E: "^",
+                self.FMT_SUB_B: "~",
+                self.FMT_SUB_E: "~",
             }
 
         self._result = ""
 
-        thisPar = []
-        tmpResult = []
+        para = []
+        lines = []
 
         for tType, _, tText, tFormat, tStyle in self._tokens:
 
-            # Process Text Type
             if tType == self.T_EMPTY:
-                if len(thisPar) > 0:
-                    tTemp = ("  \n".join(thisPar)).rstrip(" ")
-                    tmpResult.append(f"{tTemp}\n\n")
-                thisPar = []
+                if len(para) > 0:
+                    tTemp = ("  \n".join(para)).rstrip(" ")
+                    lines.append(f"{tTemp}\n\n")
+                para = []
 
             elif tType == self.T_TITLE:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"# {tHead}\n\n")
+                lines.append(f"# {tHead}\n\n")
 
             elif tType == self.T_UNNUM:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"## {tHead}\n\n")
+                lines.append(f"## {tHead}\n\n")
 
             elif tType == self.T_HEAD1:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"# {tHead}\n\n")
+                lines.append(f"# {tHead}\n\n")
 
             elif tType == self.T_HEAD2:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"## {tHead}\n\n")
+                lines.append(f"## {tHead}\n\n")
 
             elif tType == self.T_HEAD3:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"### {tHead}\n\n")
+                lines.append(f"### {tHead}\n\n")
 
             elif tType == self.T_HEAD4:
                 tHead = tText.replace(nwHeadFmt.BR, "\n")
-                tmpResult.append(f"#### {tHead}\n\n")
+                lines.append(f"#### {tHead}\n\n")
 
             elif tType == self.T_SEP:
-                tmpResult.append("%s\n\n" % tText)
+                lines.append(f"{tText}\n\n")
 
             elif tType == self.T_SKIP:
-                tmpResult.append("\n\n\n")
+                lines.append("\n\n\n")
 
             elif tType == self.T_TEXT:
                 tTemp = tText
-                for xPos, xLen, xFmt in reversed(tFormat):
-                    tTemp = tTemp[:xPos] + mdTags[xFmt] + tTemp[xPos+xLen:]
-                thisPar.append(tTemp.rstrip())
+                for pos, fmt in reversed(tFormat):
+                    tTemp = f"{tTemp[:pos]}{mdTags[fmt]}{tTemp[pos:]}"
+                para.append(tTemp.rstrip())
 
             elif tType == self.T_SYNOPSIS and self._doSynopsis:
-                locName = self._localLookup("Synopsis")
-                tmpResult.append(f"**{locName}:** {tText}\n\n")
+                label = self._localLookup("Synopsis")
+                lines.append(f"**{label}:** {tText}\n\n")
+
+            elif tType == self.T_SHORT and self._doSynopsis:
+                label = self._localLookup("Short Description")
+                lines.append(f"**{label}:** {tText}\n\n")
 
             elif tType == self.T_COMMENT and self._doComments:
-                locName = self._localLookup("Comment")
-                tmpResult.append(f"**{locName}:** {tText}\n\n")
+                label = self._localLookup("Comment")
+                lines.append(f"**{label}:** {tText}\n\n")
 
             elif tType == self.T_KEYWORD and self._doKeywords:
-                tmpResult.append(self._formatKeywords(tText, tStyle))
-
-        self._result = "".join(tmpResult)
-        tmpResult = []
+                lines.append(self._formatKeywords(tText, tStyle))
 
+        self._result = "".join(lines)
         self._fullMD.append(self._result)
 
         return
@@ -200,7 +213,7 @@ class ToMarkdown(Tokenizer):
 
         result = ""
         if bits[0] in nwLabels.KEY_NAME:
-            result += f"**{nwLabels.KEY_NAME[bits[0]]}:** "
+            result += f"**{self._localLookup(nwLabels.KEY_NAME[bits[0]])}:** "
             if len(bits) > 1:
                 result += ", ".join(bits[1:])