From 26ac68e98e93b3604c7bd12d89fddafec820ebc5 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Tue, 16 Apr 2024 00:37:26 +0200 Subject: [PATCH] Block footnotes in footnotes, and only output referenced footnotes --- novelwriter/core/tohtml.py | 11 ++++++++--- novelwriter/core/tokenizer.py | 25 ++++++++++++++++--------- novelwriter/core/tomd.py | 15 ++++++++++----- 3 files changed, 34 insertions(+), 17 deletions(-) diff --git a/novelwriter/core/tohtml.py b/novelwriter/core/tohtml.py index 07621512..604799be 100644 --- a/novelwriter/core/tohtml.py +++ b/novelwriter/core/tohtml.py @@ -52,6 +52,7 @@ HTML4_TAGS = { Tokenizer.FMT_SUP_E: "", Tokenizer.FMT_SUB_B: "", Tokenizer.FMT_SUB_E: "", + Tokenizer.FMT_STRIP: "", } HTML5_TAGS = { @@ -69,6 +70,7 @@ HTML5_TAGS = { Tokenizer.FMT_SUP_E: "", Tokenizer.FMT_SUB_B: "", Tokenizer.FMT_SUB_E: "", + Tokenizer.FMT_STRIP: "", } @@ -92,6 +94,7 @@ class ToHtml(Tokenizer): # Internals self._trMap = {} + self._usedNotes = set() self.setReplaceUnicode(False) return @@ -310,9 +313,10 @@ class ToHtml(Tokenizer): lines = [] lines.append(f"

{footnotes}

\n") lines.append("
    \n") - for index, content in self._footnotes.values(): - text = "

    ".join(self._formatText(t, f, tags) for t, f in content) - lines.append(f"

  1. {text}

    2. \n") + for key, (index, content) in self._footnotes.items(): + if key in self._usedNotes: + text = "

    ".join(self._formatText(t, f, tags) for t, f in content) + lines.append(f"

  2. {text}

    3. \n") lines.append("
\n") result = "".join(lines) @@ -478,6 +482,7 @@ class ToHtml(Tokenizer): for pos, fmt, data in reversed(tFmt): html = "" if fmt == self.FMT_FNOTE: + self._usedNotes.add(data) index = self._footnotes.get(data, (0, ""))[0] or "ERR" html = f"[{index}]" else: diff --git a/novelwriter/core/tokenizer.py b/novelwriter/core/tokenizer.py index 8f8161bd..db1a5f3f 100644 --- a/novelwriter/core/tokenizer.py +++ b/novelwriter/core/tokenizer.py @@ -84,6 +84,7 @@ class Tokenizer(ABC): FMT_SUB_B = 13 # Begin subscript FMT_SUB_E = 14 # End subscript FMT_FNOTE = 15 # Footnote marker + FMT_STRIP = 16 # Strip the format code # Block Type T_EMPTY = 1 # Empty line (new paragraph) @@ -140,6 +141,7 @@ class Tokenizer(ABC): self._textFixed = False # Fixed width text self._lineHeight = 1.15 # Line height in units of em self._blockIndent = 4.00 # Block indent in units of em + self._textIndent = 1.40 # First line indent in units of em self._doJustify = False # Justify text self._doBodyText = True # Include body text self._doSynopsis = False # Also process synopsis comments @@ -155,6 +157,7 @@ class Tokenizer(ABC): self._marginHead4 = (0.584, 0.500) self._marginText = (0.000, 0.584) self._marginMeta = (0.000, 0.584) + self._marginFoot = (1.417, 0.467) # Title Formats self._fmtTitle = nwHeadFmt.TITLE # Formatting for titles @@ -542,26 +545,29 @@ class Tokenizer(ABC): continue cStyle, cKey, cText, _, _ = processComment(aLine) - tLine, fmtPos = self._extractFormats(cText) if cStyle == nwComment.SYNOPSIS: + tLine, tFmt = self._extractFormats(cText) self._tokens.append(( - self.T_SYNOPSIS, nHead, tLine, fmtPos, sAlign + self.T_SYNOPSIS, nHead, tLine, tFmt, sAlign )) if self._doSynopsis and self._keepMarkdown: tmpMarkdown.append(f"{aLine}\n") elif cStyle == nwComment.SHORT: + tLine, tFmt = self._extractFormats(cText) self._tokens.append(( - self.T_SHORT, nHead, tLine, fmtPos, sAlign + self.T_SHORT, nHead, tLine, tFmt, sAlign )) if self._doSynopsis and self._keepMarkdown: tmpMarkdown.append(f"{aLine}\n") elif cStyle == nwComment.FOOTNOTE: + tLine, tFmt = self._extractFormats(cText, skip=self.FMT_FNOTE) if cKey not in self._footnotes: self._footnotes[cKey] = (len(self._footnotes) + 1, []) - self._footnotes[cKey][1].append((tLine, fmtPos)) + self._footnotes[cKey][1].append((tLine, tFmt)) else: + tLine, tFmt = self._extractFormats(cText) self._tokens.append(( - self.T_COMMENT, nHead, tLine, fmtPos, sAlign + self.T_COMMENT, nHead, tLine, tFmt, sAlign )) if self._doComments and self._keepMarkdown: tmpMarkdown.append(f"{aLine}\n") @@ -763,9 +769,9 @@ class Tokenizer(ABC): sAlign |= self.A_IND_R # Process formats - tLine, fmtPos = self._extractFormats(aLine) + tLine, tFmt = self._extractFormats(aLine) self._tokens.append(( - self.T_TEXT, nHead, tLine, fmtPos, sAlign + self.T_TEXT, nHead, tLine, tFmt, sAlign )) if self._keepMarkdown: tmpMarkdown.append(f"{aLine}\n") @@ -976,7 +982,7 @@ class Tokenizer(ABC): # Internal Functions ## - def _extractFormats(self, text: str) -> tuple[str, T_Formats]: + def _extractFormats(self, text: str, skip: int = 0) -> tuple[str, T_Formats]: """Extract format markers from a text paragraph.""" temp: list[tuple[int, int, int, str]] = [] @@ -1005,10 +1011,11 @@ class Tokenizer(ABC): rxItt = self._rxShortCodeVals.globalMatch(text, 0) while rxItt.hasNext(): rxMatch = rxItt.next() + kind = self._shortCodeVals.get(rxMatch.captured(1).lower(), 0) temp.append(( rxMatch.capturedStart(0), rxMatch.capturedLength(0), - self._shortCodeVals.get(rxMatch.captured(1).lower(), 0), + self.FMT_STRIP if kind == skip else kind, rxMatch.captured(2), )) diff --git a/novelwriter/core/tomd.py b/novelwriter/core/tomd.py index 567953ab..1d5fa318 100644 --- a/novelwriter/core/tomd.py +++ b/novelwriter/core/tomd.py @@ -50,6 +50,7 @@ STD_MD = { Tokenizer.FMT_SUP_E: "", Tokenizer.FMT_SUB_B: "", Tokenizer.FMT_SUB_E: "", + Tokenizer.FMT_STRIP: "", } # Extended Markdown @@ -68,6 +69,7 @@ EXT_MD = { Tokenizer.FMT_SUP_E: "^", Tokenizer.FMT_SUB_B: "~", Tokenizer.FMT_SUB_E: "~", + Tokenizer.FMT_STRIP: "", } @@ -87,6 +89,7 @@ class ToMarkdown(Tokenizer): self._genMode = self.M_STD self._fullMD: list[str] = [] self._preserveBreaks = True + self._usedNotes = set() return ## @@ -205,11 +208,12 @@ class ToMarkdown(Tokenizer): lines = [] lines.append(f"### {footnotes}\n\n") - for index, content in self._footnotes.values(): - marker = f"{index}. " - indent = "\n\n"+" "*len(marker) - text = indent.join(self._formatText(t, f, tags) for t, f in content) - lines.append(f"{marker}{text}\n") + for key, (index, content) in self._footnotes.items(): + if key in self._usedNotes: + marker = f"{index}. " + indent = "\n\n"+" "*len(marker) + text = indent.join(self._formatText(t, f, tags) for t, f in content) + lines.append(f"{marker}{text}\n") lines.append("\n") result = "".join(lines) @@ -243,6 +247,7 @@ class ToMarkdown(Tokenizer): for pos, fmt, data in reversed(tFmt): md = "" if fmt == self.FMT_FNOTE: + self._usedNotes.add(data) index = self._footnotes.get(data, (0, ""))[0] or "ERR" md = f"[{index}]" else: